Interface QuickSightAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
Amazon Quick Sight is a fully managed, serverless business intelligence service for the Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon Quick Sight.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionbatchCreateTopicReviewedAnswer(Consumer<BatchCreateTopicReviewedAnswerRequest.Builder> batchCreateTopicReviewedAnswerRequest) Creates new reviewed answers for a Q Topic.batchCreateTopicReviewedAnswer(BatchCreateTopicReviewedAnswerRequest batchCreateTopicReviewedAnswerRequest) Creates new reviewed answers for a Q Topic.batchDeleteTopicReviewedAnswer(Consumer<BatchDeleteTopicReviewedAnswerRequest.Builder> batchDeleteTopicReviewedAnswerRequest) Deletes reviewed answers for Q Topic.batchDeleteTopicReviewedAnswer(BatchDeleteTopicReviewedAnswerRequest batchDeleteTopicReviewedAnswerRequest) Deletes reviewed answers for Q Topic.static QuickSightAsyncClientBuilderbuilder()Create a builder that can be used to configure and create aQuickSightAsyncClient.default CompletableFuture<CancelIngestionResponse> cancelIngestion(Consumer<CancelIngestionRequest.Builder> cancelIngestionRequest) Cancels an ongoing ingestion of data into SPICE.default CompletableFuture<CancelIngestionResponse> cancelIngestion(CancelIngestionRequest cancelIngestionRequest) Cancels an ongoing ingestion of data into SPICE.static QuickSightAsyncClientcreate()Create aQuickSightAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.createAccountCustomization(Consumer<CreateAccountCustomizationRequest.Builder> createAccountCustomizationRequest) Creates Amazon Quick Sight customizations.createAccountCustomization(CreateAccountCustomizationRequest createAccountCustomizationRequest) Creates Amazon Quick Sight customizations.createAccountSubscription(Consumer<CreateAccountSubscriptionRequest.Builder> createAccountSubscriptionRequest) Creates an Amazon Quick Sight account, or subscribes to Amazon Quick Sight Q.createAccountSubscription(CreateAccountSubscriptionRequest createAccountSubscriptionRequest) Creates an Amazon Quick Sight account, or subscribes to Amazon Quick Sight Q.createActionConnector(Consumer<CreateActionConnectorRequest.Builder> createActionConnectorRequest) Creates an action connector that enables Amazon Quick Sight to connect to external services and perform actions.createActionConnector(CreateActionConnectorRequest createActionConnectorRequest) Creates an action connector that enables Amazon Quick Sight to connect to external services and perform actions.default CompletableFuture<CreateAnalysisResponse> createAnalysis(Consumer<CreateAnalysisRequest.Builder> createAnalysisRequest) Creates an analysis in Amazon Quick Sight.default CompletableFuture<CreateAnalysisResponse> createAnalysis(CreateAnalysisRequest createAnalysisRequest) Creates an analysis in Amazon Quick Sight.default CompletableFuture<CreateBrandResponse> createBrand(Consumer<CreateBrandRequest.Builder> createBrandRequest) Creates an Quick Sight brand.default CompletableFuture<CreateBrandResponse> createBrand(CreateBrandRequest createBrandRequest) Creates an Quick Sight brand.createCustomPermissions(Consumer<CreateCustomPermissionsRequest.Builder> createCustomPermissionsRequest) Creates a custom permissions profile.createCustomPermissions(CreateCustomPermissionsRequest createCustomPermissionsRequest) Creates a custom permissions profile.default CompletableFuture<CreateDashboardResponse> createDashboard(Consumer<CreateDashboardRequest.Builder> createDashboardRequest) Creates a dashboard from either a template or directly with aDashboardDefinition.default CompletableFuture<CreateDashboardResponse> createDashboard(CreateDashboardRequest createDashboardRequest) Creates a dashboard from either a template or directly with aDashboardDefinition.default CompletableFuture<CreateDataSetResponse> createDataSet(Consumer<CreateDataSetRequest.Builder> createDataSetRequest) Creates a dataset.default CompletableFuture<CreateDataSetResponse> createDataSet(CreateDataSetRequest createDataSetRequest) Creates a dataset.createDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest) Creates a data source.createDataSource(CreateDataSourceRequest createDataSourceRequest) Creates a data source.default CompletableFuture<CreateFolderResponse> createFolder(Consumer<CreateFolderRequest.Builder> createFolderRequest) Creates an empty shared folder.default CompletableFuture<CreateFolderResponse> createFolder(CreateFolderRequest createFolderRequest) Creates an empty shared folder.createFolderMembership(Consumer<CreateFolderMembershipRequest.Builder> createFolderMembershipRequest) Adds an asset, such as a dashboard, analysis, or dataset into a folder.createFolderMembership(CreateFolderMembershipRequest createFolderMembershipRequest) Adds an asset, such as a dashboard, analysis, or dataset into a folder.default CompletableFuture<CreateGroupResponse> createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest) Use theCreateGroupoperation to create a group in Quick Sight.default CompletableFuture<CreateGroupResponse> createGroup(CreateGroupRequest createGroupRequest) Use theCreateGroupoperation to create a group in Quick Sight.createGroupMembership(Consumer<CreateGroupMembershipRequest.Builder> createGroupMembershipRequest) Adds an Amazon Quick Sight user to an Amazon Quick Sight group.createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest) Adds an Amazon Quick Sight user to an Amazon Quick Sight group.createIAMPolicyAssignment(Consumer<CreateIamPolicyAssignmentRequest.Builder> createIamPolicyAssignmentRequest) Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN).createIAMPolicyAssignment(CreateIamPolicyAssignmentRequest createIamPolicyAssignmentRequest) Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN).default CompletableFuture<CreateIngestionResponse> createIngestion(Consumer<CreateIngestionRequest.Builder> createIngestionRequest) Creates and starts a new SPICE ingestion for a dataset.default CompletableFuture<CreateIngestionResponse> createIngestion(CreateIngestionRequest createIngestionRequest) Creates and starts a new SPICE ingestion for a dataset.default CompletableFuture<CreateNamespaceResponse> createNamespace(Consumer<CreateNamespaceRequest.Builder> createNamespaceRequest) (Enterprise edition only) Creates a new namespace for you to use with Amazon Quick Sight.default CompletableFuture<CreateNamespaceResponse> createNamespace(CreateNamespaceRequest createNamespaceRequest) (Enterprise edition only) Creates a new namespace for you to use with Amazon Quick Sight.createRefreshSchedule(Consumer<CreateRefreshScheduleRequest.Builder> createRefreshScheduleRequest) Creates a refresh schedule for a dataset.createRefreshSchedule(CreateRefreshScheduleRequest createRefreshScheduleRequest) Creates a refresh schedule for a dataset.createRoleMembership(Consumer<CreateRoleMembershipRequest.Builder> createRoleMembershipRequest) UseCreateRoleMembershipto add an existing Quick Sight group to an existing role.createRoleMembership(CreateRoleMembershipRequest createRoleMembershipRequest) UseCreateRoleMembershipto add an existing Quick Sight group to an existing role.default CompletableFuture<CreateTemplateResponse> createTemplate(Consumer<CreateTemplateRequest.Builder> createTemplateRequest) Creates a template either from aTemplateDefinitionor from an existing Quick Sight analysis or template.default CompletableFuture<CreateTemplateResponse> createTemplate(CreateTemplateRequest createTemplateRequest) Creates a template either from aTemplateDefinitionor from an existing Quick Sight analysis or template.createTemplateAlias(Consumer<CreateTemplateAliasRequest.Builder> createTemplateAliasRequest) Creates a template alias for a template.createTemplateAlias(CreateTemplateAliasRequest createTemplateAliasRequest) Creates a template alias for a template.default CompletableFuture<CreateThemeResponse> createTheme(Consumer<CreateThemeRequest.Builder> createThemeRequest) Creates a theme.default CompletableFuture<CreateThemeResponse> createTheme(CreateThemeRequest createThemeRequest) Creates a theme.createThemeAlias(Consumer<CreateThemeAliasRequest.Builder> createThemeAliasRequest) Creates a theme alias for a theme.createThemeAlias(CreateThemeAliasRequest createThemeAliasRequest) Creates a theme alias for a theme.default CompletableFuture<CreateTopicResponse> createTopic(Consumer<CreateTopicRequest.Builder> createTopicRequest) Creates a new Q topic.default CompletableFuture<CreateTopicResponse> createTopic(CreateTopicRequest createTopicRequest) Creates a new Q topic.createTopicRefreshSchedule(Consumer<CreateTopicRefreshScheduleRequest.Builder> createTopicRefreshScheduleRequest) Creates a topic refresh schedule.createTopicRefreshSchedule(CreateTopicRefreshScheduleRequest createTopicRefreshScheduleRequest) Creates a topic refresh schedule.createVPCConnection(Consumer<CreateVpcConnectionRequest.Builder> createVpcConnectionRequest) Creates a new VPC connection.createVPCConnection(CreateVpcConnectionRequest createVpcConnectionRequest) Creates a new VPC connection.deleteAccountCustomization(Consumer<DeleteAccountCustomizationRequest.Builder> deleteAccountCustomizationRequest) deleteAccountCustomization(DeleteAccountCustomizationRequest deleteAccountCustomizationRequest) deleteAccountCustomPermission(Consumer<DeleteAccountCustomPermissionRequest.Builder> deleteAccountCustomPermissionRequest) Unapplies a custom permissions profile from an account.deleteAccountCustomPermission(DeleteAccountCustomPermissionRequest deleteAccountCustomPermissionRequest) Unapplies a custom permissions profile from an account.deleteAccountSubscription(Consumer<DeleteAccountSubscriptionRequest.Builder> deleteAccountSubscriptionRequest) deleteAccountSubscription(DeleteAccountSubscriptionRequest deleteAccountSubscriptionRequest) deleteActionConnector(Consumer<DeleteActionConnectorRequest.Builder> deleteActionConnectorRequest) Hard deletes an action connector, making it unrecoverable.deleteActionConnector(DeleteActionConnectorRequest deleteActionConnectorRequest) Hard deletes an action connector, making it unrecoverable.default CompletableFuture<DeleteAnalysisResponse> deleteAnalysis(Consumer<DeleteAnalysisRequest.Builder> deleteAnalysisRequest) Deletes an analysis from Amazon Quick Sight.default CompletableFuture<DeleteAnalysisResponse> deleteAnalysis(DeleteAnalysisRequest deleteAnalysisRequest) Deletes an analysis from Amazon Quick Sight.default CompletableFuture<DeleteBrandResponse> deleteBrand(Consumer<DeleteBrandRequest.Builder> deleteBrandRequest) default CompletableFuture<DeleteBrandResponse> deleteBrand(DeleteBrandRequest deleteBrandRequest) deleteBrandAssignment(Consumer<DeleteBrandAssignmentRequest.Builder> deleteBrandAssignmentRequest) Deletes a brand assignment.deleteBrandAssignment(DeleteBrandAssignmentRequest deleteBrandAssignmentRequest) Deletes a brand assignment.deleteCustomPermissions(Consumer<DeleteCustomPermissionsRequest.Builder> deleteCustomPermissionsRequest) Deletes a custom permissions profile.deleteCustomPermissions(DeleteCustomPermissionsRequest deleteCustomPermissionsRequest) Deletes a custom permissions profile.default CompletableFuture<DeleteDashboardResponse> deleteDashboard(Consumer<DeleteDashboardRequest.Builder> deleteDashboardRequest) Deletes a dashboard.default CompletableFuture<DeleteDashboardResponse> deleteDashboard(DeleteDashboardRequest deleteDashboardRequest) Deletes a dashboard.default CompletableFuture<DeleteDataSetResponse> deleteDataSet(Consumer<DeleteDataSetRequest.Builder> deleteDataSetRequest) Deletes a dataset.default CompletableFuture<DeleteDataSetResponse> deleteDataSet(DeleteDataSetRequest deleteDataSetRequest) Deletes a dataset.deleteDataSetRefreshProperties(Consumer<DeleteDataSetRefreshPropertiesRequest.Builder> deleteDataSetRefreshPropertiesRequest) Deletes the dataset refresh properties of the dataset.deleteDataSetRefreshProperties(DeleteDataSetRefreshPropertiesRequest deleteDataSetRefreshPropertiesRequest) Deletes the dataset refresh properties of the dataset.deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest) Deletes the data source permanently.deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest) Deletes the data source permanently.deleteDefaultQBusinessApplication(Consumer<DeleteDefaultQBusinessApplicationRequest.Builder> deleteDefaultQBusinessApplicationRequest) Deletes a linked Amazon Q Business application from an Quick Sight accountdeleteDefaultQBusinessApplication(DeleteDefaultQBusinessApplicationRequest deleteDefaultQBusinessApplicationRequest) Deletes a linked Amazon Q Business application from an Quick Sight accountdefault CompletableFuture<DeleteFolderResponse> deleteFolder(Consumer<DeleteFolderRequest.Builder> deleteFolderRequest) Deletes an empty folder.default CompletableFuture<DeleteFolderResponse> deleteFolder(DeleteFolderRequest deleteFolderRequest) Deletes an empty folder.deleteFolderMembership(Consumer<DeleteFolderMembershipRequest.Builder> deleteFolderMembershipRequest) Removes an asset, such as a dashboard, analysis, or dataset, from a folder.deleteFolderMembership(DeleteFolderMembershipRequest deleteFolderMembershipRequest) Removes an asset, such as a dashboard, analysis, or dataset, from a folder.default CompletableFuture<DeleteGroupResponse> deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) Removes a user group from Amazon Quick Sight.default CompletableFuture<DeleteGroupResponse> deleteGroup(DeleteGroupRequest deleteGroupRequest) Removes a user group from Amazon Quick Sight.deleteGroupMembership(Consumer<DeleteGroupMembershipRequest.Builder> deleteGroupMembershipRequest) Removes a user from a group so that the user is no longer a member of the group.deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest) Removes a user from a group so that the user is no longer a member of the group.deleteIAMPolicyAssignment(Consumer<DeleteIamPolicyAssignmentRequest.Builder> deleteIamPolicyAssignmentRequest) Deletes an existing IAM policy assignment.deleteIAMPolicyAssignment(DeleteIamPolicyAssignmentRequest deleteIamPolicyAssignmentRequest) Deletes an existing IAM policy assignment.deleteIdentityPropagationConfig(Consumer<DeleteIdentityPropagationConfigRequest.Builder> deleteIdentityPropagationConfigRequest) Deletes all access scopes and authorized targets that are associated with a service from the Quick Sight IAM Identity Center application.deleteIdentityPropagationConfig(DeleteIdentityPropagationConfigRequest deleteIdentityPropagationConfigRequest) Deletes all access scopes and authorized targets that are associated with a service from the Quick Sight IAM Identity Center application.default CompletableFuture<DeleteNamespaceResponse> deleteNamespace(Consumer<DeleteNamespaceRequest.Builder> deleteNamespaceRequest) Deletes a namespace and the users and groups that are associated with the namespace.default CompletableFuture<DeleteNamespaceResponse> deleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest) Deletes a namespace and the users and groups that are associated with the namespace.deleteRefreshSchedule(Consumer<DeleteRefreshScheduleRequest.Builder> deleteRefreshScheduleRequest) Deletes a refresh schedule from a dataset.deleteRefreshSchedule(DeleteRefreshScheduleRequest deleteRefreshScheduleRequest) Deletes a refresh schedule from a dataset.deleteRoleCustomPermission(Consumer<DeleteRoleCustomPermissionRequest.Builder> deleteRoleCustomPermissionRequest) Removes custom permissions from the role.deleteRoleCustomPermission(DeleteRoleCustomPermissionRequest deleteRoleCustomPermissionRequest) Removes custom permissions from the role.deleteRoleMembership(Consumer<DeleteRoleMembershipRequest.Builder> deleteRoleMembershipRequest) Removes a group from a role.deleteRoleMembership(DeleteRoleMembershipRequest deleteRoleMembershipRequest) Removes a group from a role.default CompletableFuture<DeleteTemplateResponse> deleteTemplate(Consumer<DeleteTemplateRequest.Builder> deleteTemplateRequest) Deletes a template.default CompletableFuture<DeleteTemplateResponse> deleteTemplate(DeleteTemplateRequest deleteTemplateRequest) Deletes a template.deleteTemplateAlias(Consumer<DeleteTemplateAliasRequest.Builder> deleteTemplateAliasRequest) Deletes the item that the specified template alias points to.deleteTemplateAlias(DeleteTemplateAliasRequest deleteTemplateAliasRequest) Deletes the item that the specified template alias points to.default CompletableFuture<DeleteThemeResponse> deleteTheme(Consumer<DeleteThemeRequest.Builder> deleteThemeRequest) Deletes a theme.default CompletableFuture<DeleteThemeResponse> deleteTheme(DeleteThemeRequest deleteThemeRequest) Deletes a theme.deleteThemeAlias(Consumer<DeleteThemeAliasRequest.Builder> deleteThemeAliasRequest) Deletes the version of the theme that the specified theme alias points to.deleteThemeAlias(DeleteThemeAliasRequest deleteThemeAliasRequest) Deletes the version of the theme that the specified theme alias points to.default CompletableFuture<DeleteTopicResponse> deleteTopic(Consumer<DeleteTopicRequest.Builder> deleteTopicRequest) Deletes a topic.default CompletableFuture<DeleteTopicResponse> deleteTopic(DeleteTopicRequest deleteTopicRequest) Deletes a topic.deleteTopicRefreshSchedule(Consumer<DeleteTopicRefreshScheduleRequest.Builder> deleteTopicRefreshScheduleRequest) Deletes a topic refresh schedule.deleteTopicRefreshSchedule(DeleteTopicRefreshScheduleRequest deleteTopicRefreshScheduleRequest) Deletes a topic refresh schedule.default CompletableFuture<DeleteUserResponse> deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) Deletes the Amazon Quick Sight user that is associated with the identity of the IAM user or role that's making the call.default CompletableFuture<DeleteUserResponse> deleteUser(DeleteUserRequest deleteUserRequest) Deletes the Amazon Quick Sight user that is associated with the identity of the IAM user or role that's making the call.deleteUserByPrincipalId(Consumer<DeleteUserByPrincipalIdRequest.Builder> deleteUserByPrincipalIdRequest) Deletes a user identified by its principal ID.deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest deleteUserByPrincipalIdRequest) Deletes a user identified by its principal ID.deleteUserCustomPermission(Consumer<DeleteUserCustomPermissionRequest.Builder> deleteUserCustomPermissionRequest) Deletes a custom permissions profile from a user.deleteUserCustomPermission(DeleteUserCustomPermissionRequest deleteUserCustomPermissionRequest) Deletes a custom permissions profile from a user.deleteVPCConnection(Consumer<DeleteVpcConnectionRequest.Builder> deleteVpcConnectionRequest) Deletes a VPC connection.deleteVPCConnection(DeleteVpcConnectionRequest deleteVpcConnectionRequest) Deletes a VPC connection.describeAccountCustomization(Consumer<DescribeAccountCustomizationRequest.Builder> describeAccountCustomizationRequest) Describes the customizations associated with the provided Amazon Web Services account and Amazon Quick Sight namespace.describeAccountCustomization(DescribeAccountCustomizationRequest describeAccountCustomizationRequest) Describes the customizations associated with the provided Amazon Web Services account and Amazon Quick Sight namespace.describeAccountCustomPermission(Consumer<DescribeAccountCustomPermissionRequest.Builder> describeAccountCustomPermissionRequest) Describes the custom permissions profile that is applied to an account.describeAccountCustomPermission(DescribeAccountCustomPermissionRequest describeAccountCustomPermissionRequest) Describes the custom permissions profile that is applied to an account.describeAccountSettings(Consumer<DescribeAccountSettingsRequest.Builder> describeAccountSettingsRequest) Describes the settings that were used when your Quick Sight subscription was first created in this Amazon Web Services account.describeAccountSettings(DescribeAccountSettingsRequest describeAccountSettingsRequest) Describes the settings that were used when your Quick Sight subscription was first created in this Amazon Web Services account.describeAccountSubscription(Consumer<DescribeAccountSubscriptionRequest.Builder> describeAccountSubscriptionRequest) Use the DescribeAccountSubscription operation to receive a description of an Quick Sight account's subscription.describeAccountSubscription(DescribeAccountSubscriptionRequest describeAccountSubscriptionRequest) Use the DescribeAccountSubscription operation to receive a description of an Quick Sight account's subscription.describeActionConnector(Consumer<DescribeActionConnectorRequest.Builder> describeActionConnectorRequest) Retrieves detailed information about an action connector, including its configuration, authentication settings, enabled actions, and current status.describeActionConnector(DescribeActionConnectorRequest describeActionConnectorRequest) Retrieves detailed information about an action connector, including its configuration, authentication settings, enabled actions, and current status.describeActionConnectorPermissions(Consumer<DescribeActionConnectorPermissionsRequest.Builder> describeActionConnectorPermissionsRequest) Retrieves the permissions configuration for an action connector, showing which users, groups, and namespaces have access and what operations they can perform.describeActionConnectorPermissions(DescribeActionConnectorPermissionsRequest describeActionConnectorPermissionsRequest) Retrieves the permissions configuration for an action connector, showing which users, groups, and namespaces have access and what operations they can perform.describeAnalysis(Consumer<DescribeAnalysisRequest.Builder> describeAnalysisRequest) Provides a summary of the metadata for an analysis.describeAnalysis(DescribeAnalysisRequest describeAnalysisRequest) Provides a summary of the metadata for an analysis.describeAnalysisDefinition(Consumer<DescribeAnalysisDefinitionRequest.Builder> describeAnalysisDefinitionRequest) Provides a detailed description of the definition of an analysis.describeAnalysisDefinition(DescribeAnalysisDefinitionRequest describeAnalysisDefinitionRequest) Provides a detailed description of the definition of an analysis.describeAnalysisPermissions(Consumer<DescribeAnalysisPermissionsRequest.Builder> describeAnalysisPermissionsRequest) Provides the read and write permissions for an analysis.describeAnalysisPermissions(DescribeAnalysisPermissionsRequest describeAnalysisPermissionsRequest) Provides the read and write permissions for an analysis.describeAssetBundleExportJob(Consumer<DescribeAssetBundleExportJobRequest.Builder> describeAssetBundleExportJobRequest) Describes an existing export job.describeAssetBundleExportJob(DescribeAssetBundleExportJobRequest describeAssetBundleExportJobRequest) Describes an existing export job.describeAssetBundleImportJob(Consumer<DescribeAssetBundleImportJobRequest.Builder> describeAssetBundleImportJobRequest) Describes an existing import job.describeAssetBundleImportJob(DescribeAssetBundleImportJobRequest describeAssetBundleImportJobRequest) Describes an existing import job.default CompletableFuture<DescribeBrandResponse> describeBrand(Consumer<DescribeBrandRequest.Builder> describeBrandRequest) Describes a brand.default CompletableFuture<DescribeBrandResponse> describeBrand(DescribeBrandRequest describeBrandRequest) Describes a brand.describeBrandAssignment(Consumer<DescribeBrandAssignmentRequest.Builder> describeBrandAssignmentRequest) Describes a brand assignment.describeBrandAssignment(DescribeBrandAssignmentRequest describeBrandAssignmentRequest) Describes a brand assignment.describeBrandPublishedVersion(Consumer<DescribeBrandPublishedVersionRequest.Builder> describeBrandPublishedVersionRequest) Describes the published version of the brand.describeBrandPublishedVersion(DescribeBrandPublishedVersionRequest describeBrandPublishedVersionRequest) Describes the published version of the brand.describeCustomPermissions(Consumer<DescribeCustomPermissionsRequest.Builder> describeCustomPermissionsRequest) Describes a custom permissions profile.describeCustomPermissions(DescribeCustomPermissionsRequest describeCustomPermissionsRequest) Describes a custom permissions profile.describeDashboard(Consumer<DescribeDashboardRequest.Builder> describeDashboardRequest) Provides a summary for a dashboard.describeDashboard(DescribeDashboardRequest describeDashboardRequest) Provides a summary for a dashboard.describeDashboardDefinition(Consumer<DescribeDashboardDefinitionRequest.Builder> describeDashboardDefinitionRequest) Provides a detailed description of the definition of a dashboard.describeDashboardDefinition(DescribeDashboardDefinitionRequest describeDashboardDefinitionRequest) Provides a detailed description of the definition of a dashboard.describeDashboardPermissions(Consumer<DescribeDashboardPermissionsRequest.Builder> describeDashboardPermissionsRequest) Describes read and write permissions for a dashboard.describeDashboardPermissions(DescribeDashboardPermissionsRequest describeDashboardPermissionsRequest) Describes read and write permissions for a dashboard.describeDashboardSnapshotJob(Consumer<DescribeDashboardSnapshotJobRequest.Builder> describeDashboardSnapshotJobRequest) Describes an existing snapshot job.describeDashboardSnapshotJob(DescribeDashboardSnapshotJobRequest describeDashboardSnapshotJobRequest) Describes an existing snapshot job.describeDashboardSnapshotJobResult(Consumer<DescribeDashboardSnapshotJobResultRequest.Builder> describeDashboardSnapshotJobResultRequest) Describes the result of an existing snapshot job that has finished running.describeDashboardSnapshotJobResult(DescribeDashboardSnapshotJobResultRequest describeDashboardSnapshotJobResultRequest) Describes the result of an existing snapshot job that has finished running.describeDashboardsQAConfiguration(Consumer<DescribeDashboardsQaConfigurationRequest.Builder> describeDashboardsQaConfigurationRequest) Describes an existing dashboard QA configuration.describeDashboardsQAConfiguration(DescribeDashboardsQaConfigurationRequest describeDashboardsQaConfigurationRequest) Describes an existing dashboard QA configuration.default CompletableFuture<DescribeDataSetResponse> describeDataSet(Consumer<DescribeDataSetRequest.Builder> describeDataSetRequest) Describes a dataset.default CompletableFuture<DescribeDataSetResponse> describeDataSet(DescribeDataSetRequest describeDataSetRequest) Describes a dataset.describeDataSetPermissions(Consumer<DescribeDataSetPermissionsRequest.Builder> describeDataSetPermissionsRequest) Describes the permissions on a dataset.describeDataSetPermissions(DescribeDataSetPermissionsRequest describeDataSetPermissionsRequest) Describes the permissions on a dataset.describeDataSetRefreshProperties(Consumer<DescribeDataSetRefreshPropertiesRequest.Builder> describeDataSetRefreshPropertiesRequest) Describes the refresh properties of a dataset.describeDataSetRefreshProperties(DescribeDataSetRefreshPropertiesRequest describeDataSetRefreshPropertiesRequest) Describes the refresh properties of a dataset.describeDataSource(Consumer<DescribeDataSourceRequest.Builder> describeDataSourceRequest) Describes a data source.describeDataSource(DescribeDataSourceRequest describeDataSourceRequest) Describes a data source.describeDataSourcePermissions(Consumer<DescribeDataSourcePermissionsRequest.Builder> describeDataSourcePermissionsRequest) Describes the resource permissions for a data source.describeDataSourcePermissions(DescribeDataSourcePermissionsRequest describeDataSourcePermissionsRequest) Describes the resource permissions for a data source.describeDefaultQBusinessApplication(Consumer<DescribeDefaultQBusinessApplicationRequest.Builder> describeDefaultQBusinessApplicationRequest) Describes a Amazon Q Business application that is linked to an Quick Sight account.describeDefaultQBusinessApplication(DescribeDefaultQBusinessApplicationRequest describeDefaultQBusinessApplicationRequest) Describes a Amazon Q Business application that is linked to an Quick Sight account.default CompletableFuture<DescribeFolderResponse> describeFolder(Consumer<DescribeFolderRequest.Builder> describeFolderRequest) Describes a folder.default CompletableFuture<DescribeFolderResponse> describeFolder(DescribeFolderRequest describeFolderRequest) Describes a folder.describeFolderPermissions(Consumer<DescribeFolderPermissionsRequest.Builder> describeFolderPermissionsRequest) Describes permissions for a folder.describeFolderPermissions(DescribeFolderPermissionsRequest describeFolderPermissionsRequest) Describes permissions for a folder.describeFolderPermissionsPaginator(Consumer<DescribeFolderPermissionsRequest.Builder> describeFolderPermissionsRequest) This is a variant ofdescribeFolderPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsRequest)operation.describeFolderPermissionsPaginator(DescribeFolderPermissionsRequest describeFolderPermissionsRequest) This is a variant ofdescribeFolderPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsRequest)operation.describeFolderResolvedPermissions(Consumer<DescribeFolderResolvedPermissionsRequest.Builder> describeFolderResolvedPermissionsRequest) Describes the folder resolved permissions.describeFolderResolvedPermissions(DescribeFolderResolvedPermissionsRequest describeFolderResolvedPermissionsRequest) Describes the folder resolved permissions.describeFolderResolvedPermissionsPaginator(Consumer<DescribeFolderResolvedPermissionsRequest.Builder> describeFolderResolvedPermissionsRequest) This is a variant ofdescribeFolderResolvedPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsRequest)operation.describeFolderResolvedPermissionsPaginator(DescribeFolderResolvedPermissionsRequest describeFolderResolvedPermissionsRequest) This is a variant ofdescribeFolderResolvedPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsRequest)operation.default CompletableFuture<DescribeGroupResponse> describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest) Returns an Amazon Quick Sight group's description and Amazon Resource Name (ARN).default CompletableFuture<DescribeGroupResponse> describeGroup(DescribeGroupRequest describeGroupRequest) Returns an Amazon Quick Sight group's description and Amazon Resource Name (ARN).describeGroupMembership(Consumer<DescribeGroupMembershipRequest.Builder> describeGroupMembershipRequest) Use theDescribeGroupMembershipoperation to determine if a user is a member of the specified group.describeGroupMembership(DescribeGroupMembershipRequest describeGroupMembershipRequest) Use theDescribeGroupMembershipoperation to determine if a user is a member of the specified group.describeIAMPolicyAssignment(Consumer<DescribeIamPolicyAssignmentRequest.Builder> describeIamPolicyAssignmentRequest) Describes an existing IAM policy assignment, as specified by the assignment name.describeIAMPolicyAssignment(DescribeIamPolicyAssignmentRequest describeIamPolicyAssignmentRequest) Describes an existing IAM policy assignment, as specified by the assignment name.describeIngestion(Consumer<DescribeIngestionRequest.Builder> describeIngestionRequest) Describes a SPICE ingestion.describeIngestion(DescribeIngestionRequest describeIngestionRequest) Describes a SPICE ingestion.describeIpRestriction(Consumer<DescribeIpRestrictionRequest.Builder> describeIpRestrictionRequest) Provides a summary and status of IP rules.describeIpRestriction(DescribeIpRestrictionRequest describeIpRestrictionRequest) Provides a summary and status of IP rules.describeKeyRegistration(Consumer<DescribeKeyRegistrationRequest.Builder> describeKeyRegistrationRequest) Describes all customer managed key registrations in a Quick Sight account.describeKeyRegistration(DescribeKeyRegistrationRequest describeKeyRegistrationRequest) Describes all customer managed key registrations in a Quick Sight account.describeNamespace(Consumer<DescribeNamespaceRequest.Builder> describeNamespaceRequest) Describes the current namespace.describeNamespace(DescribeNamespaceRequest describeNamespaceRequest) Describes the current namespace.describeQPersonalizationConfiguration(Consumer<DescribeQPersonalizationConfigurationRequest.Builder> describeQPersonalizationConfigurationRequest) Describes a personalization configuration.describeQPersonalizationConfiguration(DescribeQPersonalizationConfigurationRequest describeQPersonalizationConfigurationRequest) Describes a personalization configuration.describeQuickSightQSearchConfiguration(Consumer<DescribeQuickSightQSearchConfigurationRequest.Builder> describeQuickSightQSearchConfigurationRequest) Describes the state of a Quick Sight Q Search configuration.describeQuickSightQSearchConfiguration(DescribeQuickSightQSearchConfigurationRequest describeQuickSightQSearchConfigurationRequest) Describes the state of a Quick Sight Q Search configuration.describeRefreshSchedule(Consumer<DescribeRefreshScheduleRequest.Builder> describeRefreshScheduleRequest) Provides a summary of a refresh schedule.describeRefreshSchedule(DescribeRefreshScheduleRequest describeRefreshScheduleRequest) Provides a summary of a refresh schedule.describeRoleCustomPermission(Consumer<DescribeRoleCustomPermissionRequest.Builder> describeRoleCustomPermissionRequest) Describes all custom permissions that are mapped to a role.describeRoleCustomPermission(DescribeRoleCustomPermissionRequest describeRoleCustomPermissionRequest) Describes all custom permissions that are mapped to a role.describeTemplate(Consumer<DescribeTemplateRequest.Builder> describeTemplateRequest) Describes a template's metadata.describeTemplate(DescribeTemplateRequest describeTemplateRequest) Describes a template's metadata.describeTemplateAlias(Consumer<DescribeTemplateAliasRequest.Builder> describeTemplateAliasRequest) Describes the template alias for a template.describeTemplateAlias(DescribeTemplateAliasRequest describeTemplateAliasRequest) Describes the template alias for a template.describeTemplateDefinition(Consumer<DescribeTemplateDefinitionRequest.Builder> describeTemplateDefinitionRequest) Provides a detailed description of the definition of a template.describeTemplateDefinition(DescribeTemplateDefinitionRequest describeTemplateDefinitionRequest) Provides a detailed description of the definition of a template.describeTemplatePermissions(Consumer<DescribeTemplatePermissionsRequest.Builder> describeTemplatePermissionsRequest) Describes read and write permissions on a template.describeTemplatePermissions(DescribeTemplatePermissionsRequest describeTemplatePermissionsRequest) Describes read and write permissions on a template.default CompletableFuture<DescribeThemeResponse> describeTheme(Consumer<DescribeThemeRequest.Builder> describeThemeRequest) Describes a theme.default CompletableFuture<DescribeThemeResponse> describeTheme(DescribeThemeRequest describeThemeRequest) Describes a theme.describeThemeAlias(Consumer<DescribeThemeAliasRequest.Builder> describeThemeAliasRequest) Describes the alias for a theme.describeThemeAlias(DescribeThemeAliasRequest describeThemeAliasRequest) Describes the alias for a theme.describeThemePermissions(Consumer<DescribeThemePermissionsRequest.Builder> describeThemePermissionsRequest) Describes the read and write permissions for a theme.describeThemePermissions(DescribeThemePermissionsRequest describeThemePermissionsRequest) Describes the read and write permissions for a theme.default CompletableFuture<DescribeTopicResponse> describeTopic(Consumer<DescribeTopicRequest.Builder> describeTopicRequest) Describes a topic.default CompletableFuture<DescribeTopicResponse> describeTopic(DescribeTopicRequest describeTopicRequest) Describes a topic.describeTopicPermissions(Consumer<DescribeTopicPermissionsRequest.Builder> describeTopicPermissionsRequest) Describes the permissions of a topic.describeTopicPermissions(DescribeTopicPermissionsRequest describeTopicPermissionsRequest) Describes the permissions of a topic.describeTopicRefresh(Consumer<DescribeTopicRefreshRequest.Builder> describeTopicRefreshRequest) Describes the status of a topic refresh.describeTopicRefresh(DescribeTopicRefreshRequest describeTopicRefreshRequest) Describes the status of a topic refresh.describeTopicRefreshSchedule(Consumer<DescribeTopicRefreshScheduleRequest.Builder> describeTopicRefreshScheduleRequest) Deletes a topic refresh schedule.describeTopicRefreshSchedule(DescribeTopicRefreshScheduleRequest describeTopicRefreshScheduleRequest) Deletes a topic refresh schedule.default CompletableFuture<DescribeUserResponse> describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest) Returns information about a user, given the user name.default CompletableFuture<DescribeUserResponse> describeUser(DescribeUserRequest describeUserRequest) Returns information about a user, given the user name.describeVPCConnection(Consumer<DescribeVpcConnectionRequest.Builder> describeVpcConnectionRequest) Describes a VPC connection.describeVPCConnection(DescribeVpcConnectionRequest describeVpcConnectionRequest) Describes a VPC connection.generateEmbedUrlForAnonymousUser(Consumer<GenerateEmbedUrlForAnonymousUserRequest.Builder> generateEmbedUrlForAnonymousUserRequest) Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users.generateEmbedUrlForAnonymousUser(GenerateEmbedUrlForAnonymousUserRequest generateEmbedUrlForAnonymousUserRequest) Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users.generateEmbedUrlForRegisteredUser(Consumer<GenerateEmbedUrlForRegisteredUserRequest.Builder> generateEmbedUrlForRegisteredUserRequest) Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website.generateEmbedUrlForRegisteredUser(GenerateEmbedUrlForRegisteredUserRequest generateEmbedUrlForRegisteredUserRequest) Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website.generateEmbedUrlForRegisteredUserWithIdentity(Consumer<GenerateEmbedUrlForRegisteredUserWithIdentityRequest.Builder> generateEmbedUrlForRegisteredUserWithIdentityRequest) Generates an embed URL that you can use to embed an Amazon Quick Sight experience in your website.generateEmbedUrlForRegisteredUserWithIdentity(GenerateEmbedUrlForRegisteredUserWithIdentityRequest generateEmbedUrlForRegisteredUserWithIdentityRequest) Generates an embed URL that you can use to embed an Amazon Quick Sight experience in your website.getDashboardEmbedUrl(Consumer<GetDashboardEmbedUrlRequest.Builder> getDashboardEmbedUrlRequest) Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon Quick Sight read-only dashboard in your website or application.getDashboardEmbedUrl(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest) Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon Quick Sight read-only dashboard in your website or application.default CompletableFuture<GetFlowMetadataResponse> getFlowMetadata(Consumer<GetFlowMetadataRequest.Builder> getFlowMetadataRequest) Retrieves the metadata of a flow, not including its definition specifying the steps.default CompletableFuture<GetFlowMetadataResponse> getFlowMetadata(GetFlowMetadataRequest getFlowMetadataRequest) Retrieves the metadata of a flow, not including its definition specifying the steps.getFlowPermissions(Consumer<GetFlowPermissionsRequest.Builder> getFlowPermissionsRequest) Get permissions for a flow.getFlowPermissions(GetFlowPermissionsRequest getFlowPermissionsRequest) Get permissions for a flow.getSessionEmbedUrl(Consumer<GetSessionEmbedUrlRequest.Builder> getSessionEmbedUrlRequest) Generates a session URL and authorization code that you can use to embed the Amazon Amazon Quick Sight console in your web server code.getSessionEmbedUrl(GetSessionEmbedUrlRequest getSessionEmbedUrlRequest) Generates a session URL and authorization code that you can use to embed the Amazon Amazon Quick Sight console in your web server code.listActionConnectors(Consumer<ListActionConnectorsRequest.Builder> listActionConnectorsRequest) Lists all action connectors in the specified Amazon Web Services account.listActionConnectors(ListActionConnectorsRequest listActionConnectorsRequest) Lists all action connectors in the specified Amazon Web Services account.default ListActionConnectorsPublisherlistActionConnectorsPaginator(Consumer<ListActionConnectorsRequest.Builder> listActionConnectorsRequest) This is a variant oflistActionConnectors(software.amazon.awssdk.services.quicksight.model.ListActionConnectorsRequest)operation.default ListActionConnectorsPublisherlistActionConnectorsPaginator(ListActionConnectorsRequest listActionConnectorsRequest) This is a variant oflistActionConnectors(software.amazon.awssdk.services.quicksight.model.ListActionConnectorsRequest)operation.default CompletableFuture<ListAnalysesResponse> listAnalyses(Consumer<ListAnalysesRequest.Builder> listAnalysesRequest) Lists Amazon Quick Sight analyses that exist in the specified Amazon Web Services account.default CompletableFuture<ListAnalysesResponse> listAnalyses(ListAnalysesRequest listAnalysesRequest) Lists Amazon Quick Sight analyses that exist in the specified Amazon Web Services account.default ListAnalysesPublisherlistAnalysesPaginator(Consumer<ListAnalysesRequest.Builder> listAnalysesRequest) This is a variant oflistAnalyses(software.amazon.awssdk.services.quicksight.model.ListAnalysesRequest)operation.default ListAnalysesPublisherlistAnalysesPaginator(ListAnalysesRequest listAnalysesRequest) This is a variant oflistAnalyses(software.amazon.awssdk.services.quicksight.model.ListAnalysesRequest)operation.listAssetBundleExportJobs(Consumer<ListAssetBundleExportJobsRequest.Builder> listAssetBundleExportJobsRequest) Lists all asset bundle export jobs that have been taken place in the last 14 days.listAssetBundleExportJobs(ListAssetBundleExportJobsRequest listAssetBundleExportJobsRequest) Lists all asset bundle export jobs that have been taken place in the last 14 days.listAssetBundleExportJobsPaginator(Consumer<ListAssetBundleExportJobsRequest.Builder> listAssetBundleExportJobsRequest) This is a variant oflistAssetBundleExportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsRequest)operation.listAssetBundleExportJobsPaginator(ListAssetBundleExportJobsRequest listAssetBundleExportJobsRequest) This is a variant oflistAssetBundleExportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsRequest)operation.listAssetBundleImportJobs(Consumer<ListAssetBundleImportJobsRequest.Builder> listAssetBundleImportJobsRequest) Lists all asset bundle import jobs that have taken place in the last 14 days.listAssetBundleImportJobs(ListAssetBundleImportJobsRequest listAssetBundleImportJobsRequest) Lists all asset bundle import jobs that have taken place in the last 14 days.listAssetBundleImportJobsPaginator(Consumer<ListAssetBundleImportJobsRequest.Builder> listAssetBundleImportJobsRequest) This is a variant oflistAssetBundleImportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsRequest)operation.listAssetBundleImportJobsPaginator(ListAssetBundleImportJobsRequest listAssetBundleImportJobsRequest) This is a variant oflistAssetBundleImportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsRequest)operation.default CompletableFuture<ListBrandsResponse> listBrands(Consumer<ListBrandsRequest.Builder> listBrandsRequest) Lists all brands in an Quick Sight account.default CompletableFuture<ListBrandsResponse> listBrands(ListBrandsRequest listBrandsRequest) Lists all brands in an Quick Sight account.default ListBrandsPublisherlistBrandsPaginator(Consumer<ListBrandsRequest.Builder> listBrandsRequest) This is a variant oflistBrands(software.amazon.awssdk.services.quicksight.model.ListBrandsRequest)operation.default ListBrandsPublisherlistBrandsPaginator(ListBrandsRequest listBrandsRequest) This is a variant oflistBrands(software.amazon.awssdk.services.quicksight.model.ListBrandsRequest)operation.listCustomPermissions(Consumer<ListCustomPermissionsRequest.Builder> listCustomPermissionsRequest) Returns a list of all the custom permissions profiles.listCustomPermissions(ListCustomPermissionsRequest listCustomPermissionsRequest) Returns a list of all the custom permissions profiles.default ListCustomPermissionsPublisherlistCustomPermissionsPaginator(Consumer<ListCustomPermissionsRequest.Builder> listCustomPermissionsRequest) This is a variant oflistCustomPermissions(software.amazon.awssdk.services.quicksight.model.ListCustomPermissionsRequest)operation.default ListCustomPermissionsPublisherlistCustomPermissionsPaginator(ListCustomPermissionsRequest listCustomPermissionsRequest) This is a variant oflistCustomPermissions(software.amazon.awssdk.services.quicksight.model.ListCustomPermissionsRequest)operation.default CompletableFuture<ListDashboardsResponse> listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest) Lists dashboards in an Amazon Web Services account.default CompletableFuture<ListDashboardsResponse> listDashboards(ListDashboardsRequest listDashboardsRequest) Lists dashboards in an Amazon Web Services account.default ListDashboardsPublisherlistDashboardsPaginator(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest) This is a variant oflistDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest)operation.default ListDashboardsPublisherlistDashboardsPaginator(ListDashboardsRequest listDashboardsRequest) This is a variant oflistDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest)operation.listDashboardVersions(Consumer<ListDashboardVersionsRequest.Builder> listDashboardVersionsRequest) Lists all the versions of the dashboards in the Amazon Quick Sight subscription.listDashboardVersions(ListDashboardVersionsRequest listDashboardVersionsRequest) Lists all the versions of the dashboards in the Amazon Quick Sight subscription.default ListDashboardVersionsPublisherlistDashboardVersionsPaginator(Consumer<ListDashboardVersionsRequest.Builder> listDashboardVersionsRequest) This is a variant oflistDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest)operation.default ListDashboardVersionsPublisherlistDashboardVersionsPaginator(ListDashboardVersionsRequest listDashboardVersionsRequest) This is a variant oflistDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest)operation.default CompletableFuture<ListDataSetsResponse> listDataSets(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest) Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.default CompletableFuture<ListDataSetsResponse> listDataSets(ListDataSetsRequest listDataSetsRequest) Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.default ListDataSetsPublisherlistDataSetsPaginator(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest) This is a variant oflistDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest)operation.default ListDataSetsPublisherlistDataSetsPaginator(ListDataSetsRequest listDataSetsRequest) This is a variant oflistDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest)operation.default CompletableFuture<ListDataSourcesResponse> listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.default CompletableFuture<ListDataSourcesResponse> listDataSources(ListDataSourcesRequest listDataSourcesRequest) Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.default ListDataSourcesPublisherlistDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) This is a variant oflistDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest)operation.default ListDataSourcesPublisherlistDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest) This is a variant oflistDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest)operation.default CompletableFuture<ListFlowsResponse> listFlows(Consumer<ListFlowsRequest.Builder> listFlowsRequest) Lists flows in an Amazon Web Services account.default CompletableFuture<ListFlowsResponse> listFlows(ListFlowsRequest listFlowsRequest) Lists flows in an Amazon Web Services account.default ListFlowsPublisherlistFlowsPaginator(Consumer<ListFlowsRequest.Builder> listFlowsRequest) This is a variant oflistFlows(software.amazon.awssdk.services.quicksight.model.ListFlowsRequest)operation.default ListFlowsPublisherlistFlowsPaginator(ListFlowsRequest listFlowsRequest) This is a variant oflistFlows(software.amazon.awssdk.services.quicksight.model.ListFlowsRequest)operation.listFolderMembers(Consumer<ListFolderMembersRequest.Builder> listFolderMembersRequest) List all assets (DASHBOARD,ANALYSIS, andDATASET) in a folder.listFolderMembers(ListFolderMembersRequest listFolderMembersRequest) List all assets (DASHBOARD,ANALYSIS, andDATASET) in a folder.default ListFolderMembersPublisherlistFolderMembersPaginator(Consumer<ListFolderMembersRequest.Builder> listFolderMembersRequest) This is a variant oflistFolderMembers(software.amazon.awssdk.services.quicksight.model.ListFolderMembersRequest)operation.default ListFolderMembersPublisherlistFolderMembersPaginator(ListFolderMembersRequest listFolderMembersRequest) This is a variant oflistFolderMembers(software.amazon.awssdk.services.quicksight.model.ListFolderMembersRequest)operation.default CompletableFuture<ListFoldersResponse> listFolders(Consumer<ListFoldersRequest.Builder> listFoldersRequest) Lists all folders in an account.default CompletableFuture<ListFoldersResponse> listFolders(ListFoldersRequest listFoldersRequest) Lists all folders in an account.listFoldersForResource(Consumer<ListFoldersForResourceRequest.Builder> listFoldersForResourceRequest) List all folders that a resource is a member of.listFoldersForResource(ListFoldersForResourceRequest listFoldersForResourceRequest) List all folders that a resource is a member of.default ListFoldersForResourcePublisherlistFoldersForResourcePaginator(Consumer<ListFoldersForResourceRequest.Builder> listFoldersForResourceRequest) This is a variant oflistFoldersForResource(software.amazon.awssdk.services.quicksight.model.ListFoldersForResourceRequest)operation.default ListFoldersForResourcePublisherlistFoldersForResourcePaginator(ListFoldersForResourceRequest listFoldersForResourceRequest) This is a variant oflistFoldersForResource(software.amazon.awssdk.services.quicksight.model.ListFoldersForResourceRequest)operation.default ListFoldersPublisherlistFoldersPaginator(Consumer<ListFoldersRequest.Builder> listFoldersRequest) This is a variant oflistFolders(software.amazon.awssdk.services.quicksight.model.ListFoldersRequest)operation.default ListFoldersPublisherlistFoldersPaginator(ListFoldersRequest listFoldersRequest) This is a variant oflistFolders(software.amazon.awssdk.services.quicksight.model.ListFoldersRequest)operation.listGroupMemberships(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest) Lists member users in a group.listGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest) Lists member users in a group.default ListGroupMembershipsPublisherlistGroupMembershipsPaginator(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest) This is a variant oflistGroupMemberships(software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsRequest)operation.default ListGroupMembershipsPublisherlistGroupMembershipsPaginator(ListGroupMembershipsRequest listGroupMembershipsRequest) This is a variant oflistGroupMemberships(software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsRequest)operation.default CompletableFuture<ListGroupsResponse> listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest) Lists all user groups in Amazon Quick Sight.default CompletableFuture<ListGroupsResponse> listGroups(ListGroupsRequest listGroupsRequest) Lists all user groups in Amazon Quick Sight.default ListGroupsPublisherlistGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest) This is a variant oflistGroups(software.amazon.awssdk.services.quicksight.model.ListGroupsRequest)operation.default ListGroupsPublisherlistGroupsPaginator(ListGroupsRequest listGroupsRequest) This is a variant oflistGroups(software.amazon.awssdk.services.quicksight.model.ListGroupsRequest)operation.listIAMPolicyAssignments(Consumer<ListIamPolicyAssignmentsRequest.Builder> listIamPolicyAssignmentsRequest) Lists the IAM policy assignments in the current Amazon Quick Sight account.listIAMPolicyAssignments(ListIamPolicyAssignmentsRequest listIamPolicyAssignmentsRequest) Lists the IAM policy assignments in the current Amazon Quick Sight account.listIAMPolicyAssignmentsForUser(Consumer<ListIamPolicyAssignmentsForUserRequest.Builder> listIamPolicyAssignmentsForUserRequest) Lists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to.listIAMPolicyAssignmentsForUser(ListIamPolicyAssignmentsForUserRequest listIamPolicyAssignmentsForUserRequest) Lists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to.listIAMPolicyAssignmentsForUserPaginator(Consumer<ListIamPolicyAssignmentsForUserRequest.Builder> listIamPolicyAssignmentsForUserRequest) This is a variant oflistIAMPolicyAssignmentsForUser(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserRequest)operation.listIAMPolicyAssignmentsForUserPaginator(ListIamPolicyAssignmentsForUserRequest listIamPolicyAssignmentsForUserRequest) This is a variant oflistIAMPolicyAssignmentsForUser(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserRequest)operation.listIAMPolicyAssignmentsPaginator(Consumer<ListIamPolicyAssignmentsRequest.Builder> listIamPolicyAssignmentsRequest) This is a variant oflistIAMPolicyAssignments(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsRequest)operation.listIAMPolicyAssignmentsPaginator(ListIamPolicyAssignmentsRequest listIamPolicyAssignmentsRequest) This is a variant oflistIAMPolicyAssignments(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsRequest)operation.listIdentityPropagationConfigs(Consumer<ListIdentityPropagationConfigsRequest.Builder> listIdentityPropagationConfigsRequest) Lists all services and authorized targets that the Quick Sight IAM Identity Center application can access.listIdentityPropagationConfigs(ListIdentityPropagationConfigsRequest listIdentityPropagationConfigsRequest) Lists all services and authorized targets that the Quick Sight IAM Identity Center application can access.default CompletableFuture<ListIngestionsResponse> listIngestions(Consumer<ListIngestionsRequest.Builder> listIngestionsRequest) Lists the history of SPICE ingestions for a dataset.default CompletableFuture<ListIngestionsResponse> listIngestions(ListIngestionsRequest listIngestionsRequest) Lists the history of SPICE ingestions for a dataset.default ListIngestionsPublisherlistIngestionsPaginator(Consumer<ListIngestionsRequest.Builder> listIngestionsRequest) This is a variant oflistIngestions(software.amazon.awssdk.services.quicksight.model.ListIngestionsRequest)operation.default ListIngestionsPublisherlistIngestionsPaginator(ListIngestionsRequest listIngestionsRequest) This is a variant oflistIngestions(software.amazon.awssdk.services.quicksight.model.ListIngestionsRequest)operation.default CompletableFuture<ListNamespacesResponse> listNamespaces(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest) Lists the namespaces for the specified Amazon Web Services account.default CompletableFuture<ListNamespacesResponse> listNamespaces(ListNamespacesRequest listNamespacesRequest) Lists the namespaces for the specified Amazon Web Services account.default ListNamespacesPublisherlistNamespacesPaginator(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest) This is a variant oflistNamespaces(software.amazon.awssdk.services.quicksight.model.ListNamespacesRequest)operation.default ListNamespacesPublisherlistNamespacesPaginator(ListNamespacesRequest listNamespacesRequest) This is a variant oflistNamespaces(software.amazon.awssdk.services.quicksight.model.ListNamespacesRequest)operation.listRefreshSchedules(Consumer<ListRefreshSchedulesRequest.Builder> listRefreshSchedulesRequest) Lists the refresh schedules of a dataset.listRefreshSchedules(ListRefreshSchedulesRequest listRefreshSchedulesRequest) Lists the refresh schedules of a dataset.listRoleMemberships(Consumer<ListRoleMembershipsRequest.Builder> listRoleMembershipsRequest) Lists all groups that are associated with a role.listRoleMemberships(ListRoleMembershipsRequest listRoleMembershipsRequest) Lists all groups that are associated with a role.default ListRoleMembershipsPublisherlistRoleMembershipsPaginator(Consumer<ListRoleMembershipsRequest.Builder> listRoleMembershipsRequest) This is a variant oflistRoleMemberships(software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsRequest)operation.default ListRoleMembershipsPublisherlistRoleMembershipsPaginator(ListRoleMembershipsRequest listRoleMembershipsRequest) This is a variant oflistRoleMemberships(software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsRequest)operation.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags assigned to a resource.listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags assigned to a resource.listTemplateAliases(Consumer<ListTemplateAliasesRequest.Builder> listTemplateAliasesRequest) Lists all the aliases of a template.listTemplateAliases(ListTemplateAliasesRequest listTemplateAliasesRequest) Lists all the aliases of a template.default ListTemplateAliasesPublisherlistTemplateAliasesPaginator(Consumer<ListTemplateAliasesRequest.Builder> listTemplateAliasesRequest) This is a variant oflistTemplateAliases(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesRequest)operation.default ListTemplateAliasesPublisherlistTemplateAliasesPaginator(ListTemplateAliasesRequest listTemplateAliasesRequest) This is a variant oflistTemplateAliases(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesRequest)operation.default CompletableFuture<ListTemplatesResponse> listTemplates(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest) Lists all the templates in the current Amazon Quick Sight account.default CompletableFuture<ListTemplatesResponse> listTemplates(ListTemplatesRequest listTemplatesRequest) Lists all the templates in the current Amazon Quick Sight account.default ListTemplatesPublisherlistTemplatesPaginator(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest) This is a variant oflistTemplates(software.amazon.awssdk.services.quicksight.model.ListTemplatesRequest)operation.default ListTemplatesPublisherlistTemplatesPaginator(ListTemplatesRequest listTemplatesRequest) This is a variant oflistTemplates(software.amazon.awssdk.services.quicksight.model.ListTemplatesRequest)operation.listTemplateVersions(Consumer<ListTemplateVersionsRequest.Builder> listTemplateVersionsRequest) Lists all the versions of the templates in the current Amazon Quick Sight account.listTemplateVersions(ListTemplateVersionsRequest listTemplateVersionsRequest) Lists all the versions of the templates in the current Amazon Quick Sight account.default ListTemplateVersionsPublisherlistTemplateVersionsPaginator(Consumer<ListTemplateVersionsRequest.Builder> listTemplateVersionsRequest) This is a variant oflistTemplateVersions(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsRequest)operation.default ListTemplateVersionsPublisherlistTemplateVersionsPaginator(ListTemplateVersionsRequest listTemplateVersionsRequest) This is a variant oflistTemplateVersions(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsRequest)operation.listThemeAliases(Consumer<ListThemeAliasesRequest.Builder> listThemeAliasesRequest) Lists all the aliases of a theme.listThemeAliases(ListThemeAliasesRequest listThemeAliasesRequest) Lists all the aliases of a theme.default CompletableFuture<ListThemesResponse> listThemes(Consumer<ListThemesRequest.Builder> listThemesRequest) Lists all the themes in the current Amazon Web Services account.default CompletableFuture<ListThemesResponse> listThemes(ListThemesRequest listThemesRequest) Lists all the themes in the current Amazon Web Services account.default ListThemesPublisherlistThemesPaginator(Consumer<ListThemesRequest.Builder> listThemesRequest) This is a variant oflistThemes(software.amazon.awssdk.services.quicksight.model.ListThemesRequest)operation.default ListThemesPublisherlistThemesPaginator(ListThemesRequest listThemesRequest) This is a variant oflistThemes(software.amazon.awssdk.services.quicksight.model.ListThemesRequest)operation.listThemeVersions(Consumer<ListThemeVersionsRequest.Builder> listThemeVersionsRequest) Lists all the versions of the themes in the current Amazon Web Services account.listThemeVersions(ListThemeVersionsRequest listThemeVersionsRequest) Lists all the versions of the themes in the current Amazon Web Services account.default ListThemeVersionsPublisherlistThemeVersionsPaginator(Consumer<ListThemeVersionsRequest.Builder> listThemeVersionsRequest) This is a variant oflistThemeVersions(software.amazon.awssdk.services.quicksight.model.ListThemeVersionsRequest)operation.default ListThemeVersionsPublisherlistThemeVersionsPaginator(ListThemeVersionsRequest listThemeVersionsRequest) This is a variant oflistThemeVersions(software.amazon.awssdk.services.quicksight.model.ListThemeVersionsRequest)operation.listTopicRefreshSchedules(Consumer<ListTopicRefreshSchedulesRequest.Builder> listTopicRefreshSchedulesRequest) Lists all of the refresh schedules for a topic.listTopicRefreshSchedules(ListTopicRefreshSchedulesRequest listTopicRefreshSchedulesRequest) Lists all of the refresh schedules for a topic.listTopicReviewedAnswers(Consumer<ListTopicReviewedAnswersRequest.Builder> listTopicReviewedAnswersRequest) Lists all reviewed answers for a Q Topic.listTopicReviewedAnswers(ListTopicReviewedAnswersRequest listTopicReviewedAnswersRequest) Lists all reviewed answers for a Q Topic.default CompletableFuture<ListTopicsResponse> listTopics(Consumer<ListTopicsRequest.Builder> listTopicsRequest) Lists all of the topics within an account.default CompletableFuture<ListTopicsResponse> listTopics(ListTopicsRequest listTopicsRequest) Lists all of the topics within an account.default ListTopicsPublisherlistTopicsPaginator(Consumer<ListTopicsRequest.Builder> listTopicsRequest) This is a variant oflistTopics(software.amazon.awssdk.services.quicksight.model.ListTopicsRequest)operation.default ListTopicsPublisherlistTopicsPaginator(ListTopicsRequest listTopicsRequest) This is a variant oflistTopics(software.amazon.awssdk.services.quicksight.model.ListTopicsRequest)operation.default CompletableFuture<ListUserGroupsResponse> listUserGroups(Consumer<ListUserGroupsRequest.Builder> listUserGroupsRequest) Lists the Amazon Quick Sight groups that an Amazon Quick Sight user is a member of.default CompletableFuture<ListUserGroupsResponse> listUserGroups(ListUserGroupsRequest listUserGroupsRequest) Lists the Amazon Quick Sight groups that an Amazon Quick Sight user is a member of.default ListUserGroupsPublisherlistUserGroupsPaginator(Consumer<ListUserGroupsRequest.Builder> listUserGroupsRequest) This is a variant oflistUserGroups(software.amazon.awssdk.services.quicksight.model.ListUserGroupsRequest)operation.default ListUserGroupsPublisherlistUserGroupsPaginator(ListUserGroupsRequest listUserGroupsRequest) This is a variant oflistUserGroups(software.amazon.awssdk.services.quicksight.model.ListUserGroupsRequest)operation.default CompletableFuture<ListUsersResponse> listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) Returns a list of all of the Amazon Quick Sight users belonging to this account.default CompletableFuture<ListUsersResponse> listUsers(ListUsersRequest listUsersRequest) Returns a list of all of the Amazon Quick Sight users belonging to this account.default ListUsersPublisherlistUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest) This is a variant oflistUsers(software.amazon.awssdk.services.quicksight.model.ListUsersRequest)operation.default ListUsersPublisherlistUsersPaginator(ListUsersRequest listUsersRequest) This is a variant oflistUsers(software.amazon.awssdk.services.quicksight.model.ListUsersRequest)operation.listVPCConnections(Consumer<ListVpcConnectionsRequest.Builder> listVpcConnectionsRequest) Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.listVPCConnections(ListVpcConnectionsRequest listVpcConnectionsRequest) Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.default ListVPCConnectionsPublisherlistVPCConnectionsPaginator(Consumer<ListVpcConnectionsRequest.Builder> listVpcConnectionsRequest) This is a variant oflistVPCConnections(software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsRequest)operation.default ListVPCConnectionsPublisherlistVPCConnectionsPaginator(ListVpcConnectionsRequest listVpcConnectionsRequest) This is a variant oflistVPCConnections(software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsRequest)operation.predictQAResults(Consumer<PredictQaResultsRequest.Builder> predictQaResultsRequest) Predicts existing visuals or generates new visuals to answer a given query.predictQAResults(PredictQaResultsRequest predictQaResultsRequest) Predicts existing visuals or generates new visuals to answer a given query.putDataSetRefreshProperties(Consumer<PutDataSetRefreshPropertiesRequest.Builder> putDataSetRefreshPropertiesRequest) Creates or updates the dataset refresh properties for the dataset.putDataSetRefreshProperties(PutDataSetRefreshPropertiesRequest putDataSetRefreshPropertiesRequest) Creates or updates the dataset refresh properties for the dataset.default CompletableFuture<RegisterUserResponse> registerUser(Consumer<RegisterUserRequest.Builder> registerUserRequest) Creates an Amazon Quick Sight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request.default CompletableFuture<RegisterUserResponse> registerUser(RegisterUserRequest registerUserRequest) Creates an Amazon Quick Sight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request.default CompletableFuture<RestoreAnalysisResponse> restoreAnalysis(Consumer<RestoreAnalysisRequest.Builder> restoreAnalysisRequest) Restores an analysis.default CompletableFuture<RestoreAnalysisResponse> restoreAnalysis(RestoreAnalysisRequest restoreAnalysisRequest) Restores an analysis.searchActionConnectors(Consumer<SearchActionConnectorsRequest.Builder> searchActionConnectorsRequest) Searches for action connectors in the specified Amazon Web Services account using filters.searchActionConnectors(SearchActionConnectorsRequest searchActionConnectorsRequest) Searches for action connectors in the specified Amazon Web Services account using filters.default SearchActionConnectorsPublishersearchActionConnectorsPaginator(Consumer<SearchActionConnectorsRequest.Builder> searchActionConnectorsRequest) This is a variant ofsearchActionConnectors(software.amazon.awssdk.services.quicksight.model.SearchActionConnectorsRequest)operation.default SearchActionConnectorsPublishersearchActionConnectorsPaginator(SearchActionConnectorsRequest searchActionConnectorsRequest) This is a variant ofsearchActionConnectors(software.amazon.awssdk.services.quicksight.model.SearchActionConnectorsRequest)operation.default CompletableFuture<SearchAnalysesResponse> searchAnalyses(Consumer<SearchAnalysesRequest.Builder> searchAnalysesRequest) Searches for analyses that belong to the user specified in the filter.default CompletableFuture<SearchAnalysesResponse> searchAnalyses(SearchAnalysesRequest searchAnalysesRequest) Searches for analyses that belong to the user specified in the filter.default SearchAnalysesPublishersearchAnalysesPaginator(Consumer<SearchAnalysesRequest.Builder> searchAnalysesRequest) This is a variant ofsearchAnalyses(software.amazon.awssdk.services.quicksight.model.SearchAnalysesRequest)operation.default SearchAnalysesPublishersearchAnalysesPaginator(SearchAnalysesRequest searchAnalysesRequest) This is a variant ofsearchAnalyses(software.amazon.awssdk.services.quicksight.model.SearchAnalysesRequest)operation.searchDashboards(Consumer<SearchDashboardsRequest.Builder> searchDashboardsRequest) Searches for dashboards that belong to a user.searchDashboards(SearchDashboardsRequest searchDashboardsRequest) Searches for dashboards that belong to a user.default SearchDashboardsPublishersearchDashboardsPaginator(Consumer<SearchDashboardsRequest.Builder> searchDashboardsRequest) This is a variant ofsearchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest)operation.default SearchDashboardsPublishersearchDashboardsPaginator(SearchDashboardsRequest searchDashboardsRequest) This is a variant ofsearchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest)operation.default CompletableFuture<SearchDataSetsResponse> searchDataSets(Consumer<SearchDataSetsRequest.Builder> searchDataSetsRequest) Use theSearchDataSetsoperation to search for datasets that belong to an account.default CompletableFuture<SearchDataSetsResponse> searchDataSets(SearchDataSetsRequest searchDataSetsRequest) Use theSearchDataSetsoperation to search for datasets that belong to an account.default SearchDataSetsPublishersearchDataSetsPaginator(Consumer<SearchDataSetsRequest.Builder> searchDataSetsRequest) This is a variant ofsearchDataSets(software.amazon.awssdk.services.quicksight.model.SearchDataSetsRequest)operation.default SearchDataSetsPublishersearchDataSetsPaginator(SearchDataSetsRequest searchDataSetsRequest) This is a variant ofsearchDataSets(software.amazon.awssdk.services.quicksight.model.SearchDataSetsRequest)operation.searchDataSources(Consumer<SearchDataSourcesRequest.Builder> searchDataSourcesRequest) Use theSearchDataSourcesoperation to search for data sources that belong to an account.searchDataSources(SearchDataSourcesRequest searchDataSourcesRequest) Use theSearchDataSourcesoperation to search for data sources that belong to an account.default SearchDataSourcesPublishersearchDataSourcesPaginator(Consumer<SearchDataSourcesRequest.Builder> searchDataSourcesRequest) This is a variant ofsearchDataSources(software.amazon.awssdk.services.quicksight.model.SearchDataSourcesRequest)operation.default SearchDataSourcesPublishersearchDataSourcesPaginator(SearchDataSourcesRequest searchDataSourcesRequest) This is a variant ofsearchDataSources(software.amazon.awssdk.services.quicksight.model.SearchDataSourcesRequest)operation.default CompletableFuture<SearchFlowsResponse> searchFlows(Consumer<SearchFlowsRequest.Builder> searchFlowsRequest) Search for the flows in an Amazon Web Services account.default CompletableFuture<SearchFlowsResponse> searchFlows(SearchFlowsRequest searchFlowsRequest) Search for the flows in an Amazon Web Services account.default SearchFlowsPublishersearchFlowsPaginator(Consumer<SearchFlowsRequest.Builder> searchFlowsRequest) This is a variant ofsearchFlows(software.amazon.awssdk.services.quicksight.model.SearchFlowsRequest)operation.default SearchFlowsPublishersearchFlowsPaginator(SearchFlowsRequest searchFlowsRequest) This is a variant ofsearchFlows(software.amazon.awssdk.services.quicksight.model.SearchFlowsRequest)operation.default CompletableFuture<SearchFoldersResponse> searchFolders(Consumer<SearchFoldersRequest.Builder> searchFoldersRequest) Searches the subfolders in a folder.default CompletableFuture<SearchFoldersResponse> searchFolders(SearchFoldersRequest searchFoldersRequest) Searches the subfolders in a folder.default SearchFoldersPublishersearchFoldersPaginator(Consumer<SearchFoldersRequest.Builder> searchFoldersRequest) This is a variant ofsearchFolders(software.amazon.awssdk.services.quicksight.model.SearchFoldersRequest)operation.default SearchFoldersPublishersearchFoldersPaginator(SearchFoldersRequest searchFoldersRequest) This is a variant ofsearchFolders(software.amazon.awssdk.services.quicksight.model.SearchFoldersRequest)operation.default CompletableFuture<SearchGroupsResponse> searchGroups(Consumer<SearchGroupsRequest.Builder> searchGroupsRequest) Use theSearchGroupsoperation to search groups in a specified Quick Sight namespace using the supplied filters.default CompletableFuture<SearchGroupsResponse> searchGroups(SearchGroupsRequest searchGroupsRequest) Use theSearchGroupsoperation to search groups in a specified Quick Sight namespace using the supplied filters.default SearchGroupsPublishersearchGroupsPaginator(Consumer<SearchGroupsRequest.Builder> searchGroupsRequest) This is a variant ofsearchGroups(software.amazon.awssdk.services.quicksight.model.SearchGroupsRequest)operation.default SearchGroupsPublishersearchGroupsPaginator(SearchGroupsRequest searchGroupsRequest) This is a variant ofsearchGroups(software.amazon.awssdk.services.quicksight.model.SearchGroupsRequest)operation.default CompletableFuture<SearchTopicsResponse> searchTopics(Consumer<SearchTopicsRequest.Builder> searchTopicsRequest) Searches for any Q topic that exists in an QuickSight account.default CompletableFuture<SearchTopicsResponse> searchTopics(SearchTopicsRequest searchTopicsRequest) Searches for any Q topic that exists in an QuickSight account.default SearchTopicsPublishersearchTopicsPaginator(Consumer<SearchTopicsRequest.Builder> searchTopicsRequest) This is a variant ofsearchTopics(software.amazon.awssdk.services.quicksight.model.SearchTopicsRequest)operation.default SearchTopicsPublishersearchTopicsPaginator(SearchTopicsRequest searchTopicsRequest) This is a variant ofsearchTopics(software.amazon.awssdk.services.quicksight.model.SearchTopicsRequest)operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartAssetBundleExportJob(Consumer<StartAssetBundleExportJobRequest.Builder> startAssetBundleExportJobRequest) Starts an Asset Bundle export job.startAssetBundleExportJob(StartAssetBundleExportJobRequest startAssetBundleExportJobRequest) Starts an Asset Bundle export job.startAssetBundleImportJob(Consumer<StartAssetBundleImportJobRequest.Builder> startAssetBundleImportJobRequest) Starts an Asset Bundle import job.startAssetBundleImportJob(StartAssetBundleImportJobRequest startAssetBundleImportJobRequest) Starts an Asset Bundle import job.startDashboardSnapshotJob(Consumer<StartDashboardSnapshotJobRequest.Builder> startDashboardSnapshotJobRequest) Starts an asynchronous job that generates a snapshot of a dashboard's output.startDashboardSnapshotJob(StartDashboardSnapshotJobRequest startDashboardSnapshotJobRequest) Starts an asynchronous job that generates a snapshot of a dashboard's output.startDashboardSnapshotJobSchedule(Consumer<StartDashboardSnapshotJobScheduleRequest.Builder> startDashboardSnapshotJobScheduleRequest) Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.startDashboardSnapshotJobSchedule(StartDashboardSnapshotJobScheduleRequest startDashboardSnapshotJobScheduleRequest) Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Assigns one or more tags (key-value pairs) to the specified Amazon Quick Sight resource.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest) Assigns one or more tags (key-value pairs) to the specified Amazon Quick Sight resource.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes a tag or tags from a resource.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes a tag or tags from a resource.updateAccountCustomization(Consumer<UpdateAccountCustomizationRequest.Builder> updateAccountCustomizationRequest) Updates Amazon Quick Sight customizations.updateAccountCustomization(UpdateAccountCustomizationRequest updateAccountCustomizationRequest) Updates Amazon Quick Sight customizations.updateAccountCustomPermission(Consumer<UpdateAccountCustomPermissionRequest.Builder> updateAccountCustomPermissionRequest) Applies a custom permissions profile to an account.updateAccountCustomPermission(UpdateAccountCustomPermissionRequest updateAccountCustomPermissionRequest) Applies a custom permissions profile to an account.updateAccountSettings(Consumer<UpdateAccountSettingsRequest.Builder> updateAccountSettingsRequest) Updates the Amazon Quick Sight settings in your Amazon Web Services account.updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest) Updates the Amazon Quick Sight settings in your Amazon Web Services account.updateActionConnector(Consumer<UpdateActionConnectorRequest.Builder> updateActionConnectorRequest) Updates an existing action connector with new configuration details, authentication settings, or enabled actions.updateActionConnector(UpdateActionConnectorRequest updateActionConnectorRequest) Updates an existing action connector with new configuration details, authentication settings, or enabled actions.updateActionConnectorPermissions(Consumer<UpdateActionConnectorPermissionsRequest.Builder> updateActionConnectorPermissionsRequest) Updates the permissions for an action connector by granting or revoking access for specific users and groups.updateActionConnectorPermissions(UpdateActionConnectorPermissionsRequest updateActionConnectorPermissionsRequest) Updates the permissions for an action connector by granting or revoking access for specific users and groups.default CompletableFuture<UpdateAnalysisResponse> updateAnalysis(Consumer<UpdateAnalysisRequest.Builder> updateAnalysisRequest) Updates an analysis in Amazon Quick Sightdefault CompletableFuture<UpdateAnalysisResponse> updateAnalysis(UpdateAnalysisRequest updateAnalysisRequest) Updates an analysis in Amazon Quick SightupdateAnalysisPermissions(Consumer<UpdateAnalysisPermissionsRequest.Builder> updateAnalysisPermissionsRequest) Updates the read and write permissions for an analysis.updateAnalysisPermissions(UpdateAnalysisPermissionsRequest updateAnalysisPermissionsRequest) Updates the read and write permissions for an analysis.updateApplicationWithTokenExchangeGrant(Consumer<UpdateApplicationWithTokenExchangeGrantRequest.Builder> updateApplicationWithTokenExchangeGrantRequest) Updates an QuickSight application with a token exchange grant.updateApplicationWithTokenExchangeGrant(UpdateApplicationWithTokenExchangeGrantRequest updateApplicationWithTokenExchangeGrantRequest) Updates an QuickSight application with a token exchange grant.default CompletableFuture<UpdateBrandResponse> updateBrand(Consumer<UpdateBrandRequest.Builder> updateBrandRequest) Updates a brand.default CompletableFuture<UpdateBrandResponse> updateBrand(UpdateBrandRequest updateBrandRequest) Updates a brand.updateBrandAssignment(Consumer<UpdateBrandAssignmentRequest.Builder> updateBrandAssignmentRequest) Updates a brand assignment.updateBrandAssignment(UpdateBrandAssignmentRequest updateBrandAssignmentRequest) Updates a brand assignment.updateBrandPublishedVersion(Consumer<UpdateBrandPublishedVersionRequest.Builder> updateBrandPublishedVersionRequest) Updates the published version of a brand.updateBrandPublishedVersion(UpdateBrandPublishedVersionRequest updateBrandPublishedVersionRequest) Updates the published version of a brand.updateCustomPermissions(Consumer<UpdateCustomPermissionsRequest.Builder> updateCustomPermissionsRequest) Updates a custom permissions profile.updateCustomPermissions(UpdateCustomPermissionsRequest updateCustomPermissionsRequest) Updates a custom permissions profile.default CompletableFuture<UpdateDashboardResponse> updateDashboard(Consumer<UpdateDashboardRequest.Builder> updateDashboardRequest) Updates a dashboard in an Amazon Web Services account.default CompletableFuture<UpdateDashboardResponse> updateDashboard(UpdateDashboardRequest updateDashboardRequest) Updates a dashboard in an Amazon Web Services account.updateDashboardLinks(Consumer<UpdateDashboardLinksRequest.Builder> updateDashboardLinksRequest) Updates the linked analyses on a dashboard.updateDashboardLinks(UpdateDashboardLinksRequest updateDashboardLinksRequest) Updates the linked analyses on a dashboard.updateDashboardPermissions(Consumer<UpdateDashboardPermissionsRequest.Builder> updateDashboardPermissionsRequest) Updates read and write permissions on a dashboard.updateDashboardPermissions(UpdateDashboardPermissionsRequest updateDashboardPermissionsRequest) Updates read and write permissions on a dashboard.updateDashboardPublishedVersion(Consumer<UpdateDashboardPublishedVersionRequest.Builder> updateDashboardPublishedVersionRequest) Updates the published version of a dashboard.updateDashboardPublishedVersion(UpdateDashboardPublishedVersionRequest updateDashboardPublishedVersionRequest) Updates the published version of a dashboard.updateDashboardsQAConfiguration(Consumer<UpdateDashboardsQaConfigurationRequest.Builder> updateDashboardsQaConfigurationRequest) Updates a Dashboard QA configuration.updateDashboardsQAConfiguration(UpdateDashboardsQaConfigurationRequest updateDashboardsQaConfigurationRequest) Updates a Dashboard QA configuration.default CompletableFuture<UpdateDataSetResponse> updateDataSet(Consumer<UpdateDataSetRequest.Builder> updateDataSetRequest) Updates a dataset.default CompletableFuture<UpdateDataSetResponse> updateDataSet(UpdateDataSetRequest updateDataSetRequest) Updates a dataset.updateDataSetPermissions(Consumer<UpdateDataSetPermissionsRequest.Builder> updateDataSetPermissionsRequest) Updates the permissions on a dataset.updateDataSetPermissions(UpdateDataSetPermissionsRequest updateDataSetPermissionsRequest) Updates the permissions on a dataset.updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest) Updates a data source.updateDataSource(UpdateDataSourceRequest updateDataSourceRequest) Updates a data source.updateDataSourcePermissions(Consumer<UpdateDataSourcePermissionsRequest.Builder> updateDataSourcePermissionsRequest) Updates the permissions to a data source.updateDataSourcePermissions(UpdateDataSourcePermissionsRequest updateDataSourcePermissionsRequest) Updates the permissions to a data source.updateDefaultQBusinessApplication(Consumer<UpdateDefaultQBusinessApplicationRequest.Builder> updateDefaultQBusinessApplicationRequest) Updates a Amazon Q Business application that is linked to a Quick Sight account.updateDefaultQBusinessApplication(UpdateDefaultQBusinessApplicationRequest updateDefaultQBusinessApplicationRequest) Updates a Amazon Q Business application that is linked to a Quick Sight account.updateFlowPermissions(Consumer<UpdateFlowPermissionsRequest.Builder> updateFlowPermissionsRequest) Updates permissions against principals on a flow.updateFlowPermissions(UpdateFlowPermissionsRequest updateFlowPermissionsRequest) Updates permissions against principals on a flow.default CompletableFuture<UpdateFolderResponse> updateFolder(Consumer<UpdateFolderRequest.Builder> updateFolderRequest) Updates the name of a folder.default CompletableFuture<UpdateFolderResponse> updateFolder(UpdateFolderRequest updateFolderRequest) Updates the name of a folder.updateFolderPermissions(Consumer<UpdateFolderPermissionsRequest.Builder> updateFolderPermissionsRequest) Updates permissions of a folder.updateFolderPermissions(UpdateFolderPermissionsRequest updateFolderPermissionsRequest) Updates permissions of a folder.default CompletableFuture<UpdateGroupResponse> updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest) Changes a group description.default CompletableFuture<UpdateGroupResponse> updateGroup(UpdateGroupRequest updateGroupRequest) Changes a group description.updateIAMPolicyAssignment(Consumer<UpdateIamPolicyAssignmentRequest.Builder> updateIamPolicyAssignmentRequest) Updates an existing IAM policy assignment.updateIAMPolicyAssignment(UpdateIamPolicyAssignmentRequest updateIamPolicyAssignmentRequest) Updates an existing IAM policy assignment.updateIdentityPropagationConfig(Consumer<UpdateIdentityPropagationConfigRequest.Builder> updateIdentityPropagationConfigRequest) Adds or updates services and authorized targets to configure what the Quick Sight IAM Identity Center application can access.updateIdentityPropagationConfig(UpdateIdentityPropagationConfigRequest updateIdentityPropagationConfigRequest) Adds or updates services and authorized targets to configure what the Quick Sight IAM Identity Center application can access.updateIpRestriction(Consumer<UpdateIpRestrictionRequest.Builder> updateIpRestrictionRequest) Updates the content and status of IP rules.updateIpRestriction(UpdateIpRestrictionRequest updateIpRestrictionRequest) Updates the content and status of IP rules.updateKeyRegistration(Consumer<UpdateKeyRegistrationRequest.Builder> updateKeyRegistrationRequest) Updates a customer managed key in a Quick Sight account.updateKeyRegistration(UpdateKeyRegistrationRequest updateKeyRegistrationRequest) Updates a customer managed key in a Quick Sight account.updatePublicSharingSettings(Consumer<UpdatePublicSharingSettingsRequest.Builder> updatePublicSharingSettingsRequest) updatePublicSharingSettings(UpdatePublicSharingSettingsRequest updatePublicSharingSettingsRequest) updateQPersonalizationConfiguration(Consumer<UpdateQPersonalizationConfigurationRequest.Builder> updateQPersonalizationConfigurationRequest) Updates a personalization configuration.updateQPersonalizationConfiguration(UpdateQPersonalizationConfigurationRequest updateQPersonalizationConfigurationRequest) Updates a personalization configuration.updateQuickSightQSearchConfiguration(Consumer<UpdateQuickSightQSearchConfigurationRequest.Builder> updateQuickSightQSearchConfigurationRequest) Updates the state of a Quick Sight Q Search configuration.updateQuickSightQSearchConfiguration(UpdateQuickSightQSearchConfigurationRequest updateQuickSightQSearchConfigurationRequest) Updates the state of a Quick Sight Q Search configuration.updateRefreshSchedule(Consumer<UpdateRefreshScheduleRequest.Builder> updateRefreshScheduleRequest) Updates a refresh schedule for a dataset.updateRefreshSchedule(UpdateRefreshScheduleRequest updateRefreshScheduleRequest) Updates a refresh schedule for a dataset.updateRoleCustomPermission(Consumer<UpdateRoleCustomPermissionRequest.Builder> updateRoleCustomPermissionRequest) Updates the custom permissions that are associated with a role.updateRoleCustomPermission(UpdateRoleCustomPermissionRequest updateRoleCustomPermissionRequest) Updates the custom permissions that are associated with a role.updateSPICECapacityConfiguration(Consumer<UpdateSpiceCapacityConfigurationRequest.Builder> updateSpiceCapacityConfigurationRequest) Updates the SPICE capacity configuration for a Quick Sight account.updateSPICECapacityConfiguration(UpdateSpiceCapacityConfigurationRequest updateSpiceCapacityConfigurationRequest) Updates the SPICE capacity configuration for a Quick Sight account.default CompletableFuture<UpdateTemplateResponse> updateTemplate(Consumer<UpdateTemplateRequest.Builder> updateTemplateRequest) Updates a template from an existing Amazon Quick Sight analysis or another template.default CompletableFuture<UpdateTemplateResponse> updateTemplate(UpdateTemplateRequest updateTemplateRequest) Updates a template from an existing Amazon Quick Sight analysis or another template.updateTemplateAlias(Consumer<UpdateTemplateAliasRequest.Builder> updateTemplateAliasRequest) Updates the template alias of a template.updateTemplateAlias(UpdateTemplateAliasRequest updateTemplateAliasRequest) Updates the template alias of a template.updateTemplatePermissions(Consumer<UpdateTemplatePermissionsRequest.Builder> updateTemplatePermissionsRequest) Updates the resource permissions for a template.updateTemplatePermissions(UpdateTemplatePermissionsRequest updateTemplatePermissionsRequest) Updates the resource permissions for a template.default CompletableFuture<UpdateThemeResponse> updateTheme(Consumer<UpdateThemeRequest.Builder> updateThemeRequest) Updates a theme.default CompletableFuture<UpdateThemeResponse> updateTheme(UpdateThemeRequest updateThemeRequest) Updates a theme.updateThemeAlias(Consumer<UpdateThemeAliasRequest.Builder> updateThemeAliasRequest) Updates an alias of a theme.updateThemeAlias(UpdateThemeAliasRequest updateThemeAliasRequest) Updates an alias of a theme.updateThemePermissions(Consumer<UpdateThemePermissionsRequest.Builder> updateThemePermissionsRequest) Updates the resource permissions for a theme.updateThemePermissions(UpdateThemePermissionsRequest updateThemePermissionsRequest) Updates the resource permissions for a theme.default CompletableFuture<UpdateTopicResponse> updateTopic(Consumer<UpdateTopicRequest.Builder> updateTopicRequest) Updates a topic.default CompletableFuture<UpdateTopicResponse> updateTopic(UpdateTopicRequest updateTopicRequest) Updates a topic.updateTopicPermissions(Consumer<UpdateTopicPermissionsRequest.Builder> updateTopicPermissionsRequest) Updates the permissions of a topic.updateTopicPermissions(UpdateTopicPermissionsRequest updateTopicPermissionsRequest) Updates the permissions of a topic.updateTopicRefreshSchedule(Consumer<UpdateTopicRefreshScheduleRequest.Builder> updateTopicRefreshScheduleRequest) Updates a topic refresh schedule.updateTopicRefreshSchedule(UpdateTopicRefreshScheduleRequest updateTopicRefreshScheduleRequest) Updates a topic refresh schedule.default CompletableFuture<UpdateUserResponse> updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) Updates an Amazon Quick Sight user.default CompletableFuture<UpdateUserResponse> updateUser(UpdateUserRequest updateUserRequest) Updates an Amazon Quick Sight user.updateUserCustomPermission(Consumer<UpdateUserCustomPermissionRequest.Builder> updateUserCustomPermissionRequest) Updates a custom permissions profile for a user.updateUserCustomPermission(UpdateUserCustomPermissionRequest updateUserCustomPermissionRequest) Updates a custom permissions profile for a user.updateVPCConnection(Consumer<UpdateVpcConnectionRequest.Builder> updateVpcConnectionRequest) Updates a VPC connection.updateVPCConnection(UpdateVpcConnectionRequest updateVpcConnectionRequest) Updates a VPC connection.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
batchCreateTopicReviewedAnswer
default CompletableFuture<BatchCreateTopicReviewedAnswerResponse> batchCreateTopicReviewedAnswer(BatchCreateTopicReviewedAnswerRequest batchCreateTopicReviewedAnswerRequest) Creates new reviewed answers for a Q Topic.
- Parameters:
batchCreateTopicReviewedAnswerRequest-- Returns:
- A Java Future containing the result of the BatchCreateTopicReviewedAnswer operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchCreateTopicReviewedAnswer
default CompletableFuture<BatchCreateTopicReviewedAnswerResponse> batchCreateTopicReviewedAnswer(Consumer<BatchCreateTopicReviewedAnswerRequest.Builder> batchCreateTopicReviewedAnswerRequest) Creates new reviewed answers for a Q Topic.
This is a convenience which creates an instance of the
BatchCreateTopicReviewedAnswerRequest.Builderavoiding the need to create one manually viaBatchCreateTopicReviewedAnswerRequest.builder()- Parameters:
batchCreateTopicReviewedAnswerRequest- AConsumerthat will call methods onBatchCreateTopicReviewedAnswerRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchCreateTopicReviewedAnswer operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchDeleteTopicReviewedAnswer
default CompletableFuture<BatchDeleteTopicReviewedAnswerResponse> batchDeleteTopicReviewedAnswer(BatchDeleteTopicReviewedAnswerRequest batchDeleteTopicReviewedAnswerRequest) Deletes reviewed answers for Q Topic.
- Parameters:
batchDeleteTopicReviewedAnswerRequest-- Returns:
- A Java Future containing the result of the BatchDeleteTopicReviewedAnswer operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchDeleteTopicReviewedAnswer
default CompletableFuture<BatchDeleteTopicReviewedAnswerResponse> batchDeleteTopicReviewedAnswer(Consumer<BatchDeleteTopicReviewedAnswerRequest.Builder> batchDeleteTopicReviewedAnswerRequest) Deletes reviewed answers for Q Topic.
This is a convenience which creates an instance of the
BatchDeleteTopicReviewedAnswerRequest.Builderavoiding the need to create one manually viaBatchDeleteTopicReviewedAnswerRequest.builder()- Parameters:
batchDeleteTopicReviewedAnswerRequest- AConsumerthat will call methods onBatchDeleteTopicReviewedAnswerRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchDeleteTopicReviewedAnswer operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelIngestion
default CompletableFuture<CancelIngestionResponse> cancelIngestion(CancelIngestionRequest cancelIngestionRequest) Cancels an ongoing ingestion of data into SPICE.
- Parameters:
cancelIngestionRequest-- Returns:
- A Java Future containing the result of the CancelIngestion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelIngestion
default CompletableFuture<CancelIngestionResponse> cancelIngestion(Consumer<CancelIngestionRequest.Builder> cancelIngestionRequest) Cancels an ongoing ingestion of data into SPICE.
This is a convenience which creates an instance of the
CancelIngestionRequest.Builderavoiding the need to create one manually viaCancelIngestionRequest.builder()- Parameters:
cancelIngestionRequest- AConsumerthat will call methods onCancelIngestionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CancelIngestion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAccountCustomization
default CompletableFuture<CreateAccountCustomizationResponse> createAccountCustomization(CreateAccountCustomizationRequest createAccountCustomizationRequest) Creates Amazon Quick Sight customizations. Currently, you can add a custom default theme by using the
CreateAccountCustomizationorUpdateAccountCustomizationAPI operation. To further customize Amazon Quick Sight by removing Amazon Quick Sight sample assets and videos for all new users, see Customizing Quick Sight in the Amazon Quick Sight User Guide.You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a Quick Sight 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
DescribeAccountCustomizationAPI operation.Before you use the
CreateAccountCustomizationAPI 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 theDescribeThemePermissionsAPI operation. To share the theme, grant permissions by using theUpdateThemePermissionsAPI operation.- Parameters:
createAccountCustomizationRequest-- Returns:
- A Java Future containing the result of the CreateAccountCustomization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAccountCustomization
default CompletableFuture<CreateAccountCustomizationResponse> createAccountCustomization(Consumer<CreateAccountCustomizationRequest.Builder> createAccountCustomizationRequest) Creates Amazon Quick Sight customizations. Currently, you can add a custom default theme by using the
CreateAccountCustomizationorUpdateAccountCustomizationAPI operation. To further customize Amazon Quick Sight by removing Amazon Quick Sight sample assets and videos for all new users, see Customizing Quick Sight in the Amazon Quick Sight User Guide.You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a Quick Sight 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
DescribeAccountCustomizationAPI operation.Before you use the
CreateAccountCustomizationAPI 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 theDescribeThemePermissionsAPI operation. To share the theme, grant permissions by using theUpdateThemePermissionsAPI operation.
This is a convenience which creates an instance of the
CreateAccountCustomizationRequest.Builderavoiding the need to create one manually viaCreateAccountCustomizationRequest.builder()- Parameters:
createAccountCustomizationRequest- AConsumerthat will call methods onCreateAccountCustomizationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateAccountCustomization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAccountSubscription
default CompletableFuture<CreateAccountSubscriptionResponse> createAccountSubscription(CreateAccountSubscriptionRequest createAccountSubscriptionRequest) Creates an Amazon Quick Sight account, or subscribes to Amazon Quick Sight Q.
The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK.
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 Quick Sight User Guide. The person who signs up for Amazon Quick Sight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon Quick Sight in the Amazon Quick Sight User Guide.
If your IAM policy includes both the
SubscribeandCreateAccountSubscriptionactions, make sure that both actions are set toAllow. If either action is set toDeny, theDenyaction 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 Quick Sight, see Passing IAM roles to Amazon Quick Sight in the Amazon Quick Sight User Guide.
You can't set default resource access on the new account from the Amazon Quick Sight API. Instead, add default resource access from the Amazon Quick Sight 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 Quick Sight User Guide.
- Parameters:
createAccountSubscriptionRequest-- Returns:
- A Java Future containing the result of the CreateAccountSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- PreconditionNotMetException One or more preconditions aren't met.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAccountSubscription
default CompletableFuture<CreateAccountSubscriptionResponse> createAccountSubscription(Consumer<CreateAccountSubscriptionRequest.Builder> createAccountSubscriptionRequest) Creates an Amazon Quick Sight account, or subscribes to Amazon Quick Sight Q.
The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK.
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 Quick Sight User Guide. The person who signs up for Amazon Quick Sight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon Quick Sight in the Amazon Quick Sight User Guide.
If your IAM policy includes both the
SubscribeandCreateAccountSubscriptionactions, make sure that both actions are set toAllow. If either action is set toDeny, theDenyaction 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 Quick Sight, see Passing IAM roles to Amazon Quick Sight in the Amazon Quick Sight User Guide.
You can't set default resource access on the new account from the Amazon Quick Sight API. Instead, add default resource access from the Amazon Quick Sight 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 Quick Sight User Guide.
This is a convenience which creates an instance of the
CreateAccountSubscriptionRequest.Builderavoiding the need to create one manually viaCreateAccountSubscriptionRequest.builder()- Parameters:
createAccountSubscriptionRequest- AConsumerthat will call methods onCreateAccountSubscriptionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateAccountSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- PreconditionNotMetException One or more preconditions aren't met.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createActionConnector
default CompletableFuture<CreateActionConnectorResponse> createActionConnector(CreateActionConnectorRequest createActionConnectorRequest) Creates an action connector that enables Amazon Quick Sight to connect to external services and perform actions. Action connectors support various authentication methods and can be configured with specific actions from supported connector types like Amazon S3, Salesforce, JIRA.
- Parameters:
createActionConnectorRequest-- Returns:
- A Java Future containing the result of the CreateActionConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createActionConnector
default CompletableFuture<CreateActionConnectorResponse> createActionConnector(Consumer<CreateActionConnectorRequest.Builder> createActionConnectorRequest) Creates an action connector that enables Amazon Quick Sight to connect to external services and perform actions. Action connectors support various authentication methods and can be configured with specific actions from supported connector types like Amazon S3, Salesforce, JIRA.
This is a convenience which creates an instance of the
CreateActionConnectorRequest.Builderavoiding the need to create one manually viaCreateActionConnectorRequest.builder()- Parameters:
createActionConnectorRequest- AConsumerthat will call methods onCreateActionConnectorRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateActionConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAnalysis
default CompletableFuture<CreateAnalysisResponse> createAnalysis(CreateAnalysisRequest createAnalysisRequest) Creates an analysis in Amazon Quick Sight. Analyses can be created either from a template or from an
AnalysisDefinition.- Parameters:
createAnalysisRequest-- Returns:
- A Java Future containing the result of the CreateAnalysis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAnalysis
default CompletableFuture<CreateAnalysisResponse> createAnalysis(Consumer<CreateAnalysisRequest.Builder> createAnalysisRequest) Creates an analysis in Amazon Quick Sight. Analyses can be created either from a template or from an
AnalysisDefinition.
This is a convenience which creates an instance of the
CreateAnalysisRequest.Builderavoiding the need to create one manually viaCreateAnalysisRequest.builder()- Parameters:
createAnalysisRequest- AConsumerthat will call methods onCreateAnalysisRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateAnalysis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createBrand
Creates an Quick Sight brand.
- Parameters:
createBrandRequest-- Returns:
- A Java Future containing the result of the CreateBrand operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- LimitExceededException A limit is exceeded.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InternalServerException An internal service exception.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createBrand
default CompletableFuture<CreateBrandResponse> createBrand(Consumer<CreateBrandRequest.Builder> createBrandRequest) Creates an Quick Sight brand.
This is a convenience which creates an instance of the
CreateBrandRequest.Builderavoiding the need to create one manually viaCreateBrandRequest.builder()- Parameters:
createBrandRequest- AConsumerthat will call methods onCreateBrandRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateBrand operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- LimitExceededException A limit is exceeded.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InternalServerException An internal service exception.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCustomPermissions
default CompletableFuture<CreateCustomPermissionsResponse> createCustomPermissions(CreateCustomPermissionsRequest createCustomPermissionsRequest) Creates a custom permissions profile.
- Parameters:
createCustomPermissionsRequest-- Returns:
- A Java Future containing the result of the CreateCustomPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCustomPermissions
default CompletableFuture<CreateCustomPermissionsResponse> createCustomPermissions(Consumer<CreateCustomPermissionsRequest.Builder> createCustomPermissionsRequest) Creates a custom permissions profile.
This is a convenience which creates an instance of the
CreateCustomPermissionsRequest.Builderavoiding the need to create one manually viaCreateCustomPermissionsRequest.builder()- Parameters:
createCustomPermissionsRequest- AConsumerthat will call methods onCreateCustomPermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateCustomPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDashboard
default CompletableFuture<CreateDashboardResponse> createDashboard(CreateDashboardRequest createDashboardRequest) Creates a dashboard from either a template or directly with a
DashboardDefinition. To first create a template, see theCreateTemplateAPI operation.A dashboard is an entity in Amazon Quick Sight that identifies Amazon Quick Sight reports, created from analyses. You can share Amazon Quick Sight 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.
- Parameters:
createDashboardRequest-- Returns:
- A Java Future containing the result of the CreateDashboard operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDashboard
default CompletableFuture<CreateDashboardResponse> createDashboard(Consumer<CreateDashboardRequest.Builder> createDashboardRequest) Creates a dashboard from either a template or directly with a
DashboardDefinition. To first create a template, see theCreateTemplateAPI operation.A dashboard is an entity in Amazon Quick Sight that identifies Amazon Quick Sight reports, created from analyses. You can share Amazon Quick Sight 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.
This is a convenience which creates an instance of the
CreateDashboardRequest.Builderavoiding the need to create one manually viaCreateDashboardRequest.builder()- Parameters:
createDashboardRequest- AConsumerthat will call methods onCreateDashboardRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateDashboard operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDataSet
default CompletableFuture<CreateDataSetResponse> createDataSet(CreateDataSetRequest createDataSetRequest) Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
- Parameters:
createDataSetRequest-- Returns:
- A Java Future containing the result of the CreateDataSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDataSet
default CompletableFuture<CreateDataSetResponse> createDataSet(Consumer<CreateDataSetRequest.Builder> createDataSetRequest) Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
This is a convenience which creates an instance of the
CreateDataSetRequest.Builderavoiding the need to create one manually viaCreateDataSetRequest.builder()- Parameters:
createDataSetRequest- AConsumerthat will call methods onCreateDataSetRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateDataSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDataSource
default CompletableFuture<CreateDataSourceResponse> createDataSource(CreateDataSourceRequest createDataSourceRequest) Creates a data source.
- Parameters:
createDataSourceRequest-- Returns:
- A Java Future containing the result of the CreateDataSource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- CustomerManagedKeyUnavailableException The customer managed key that is registered to your Amazon Quick Sight account is unavailable.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDataSource
default CompletableFuture<CreateDataSourceResponse> createDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest) Creates a data source.
This is a convenience which creates an instance of the
CreateDataSourceRequest.Builderavoiding the need to create one manually viaCreateDataSourceRequest.builder()- Parameters:
createDataSourceRequest- AConsumerthat will call methods onCreateDataSourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateDataSource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- CustomerManagedKeyUnavailableException The customer managed key that is registered to your Amazon Quick Sight account is unavailable.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createFolder
default CompletableFuture<CreateFolderResponse> createFolder(CreateFolderRequest createFolderRequest) Creates an empty shared folder.
- Parameters:
createFolderRequest-- Returns:
- A Java Future containing the result of the CreateFolder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createFolder
default CompletableFuture<CreateFolderResponse> createFolder(Consumer<CreateFolderRequest.Builder> createFolderRequest) Creates an empty shared folder.
This is a convenience which creates an instance of the
CreateFolderRequest.Builderavoiding the need to create one manually viaCreateFolderRequest.builder()- Parameters:
createFolderRequest- AConsumerthat will call methods onCreateFolderRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateFolder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createFolderMembership
default CompletableFuture<CreateFolderMembershipResponse> createFolderMembership(CreateFolderMembershipRequest createFolderMembershipRequest) Adds an asset, such as a dashboard, analysis, or dataset into a folder.
- Parameters:
createFolderMembershipRequest-- Returns:
- A Java Future containing the result of the CreateFolderMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createFolderMembership
default CompletableFuture<CreateFolderMembershipResponse> createFolderMembership(Consumer<CreateFolderMembershipRequest.Builder> createFolderMembershipRequest) Adds an asset, such as a dashboard, analysis, or dataset into a folder.
This is a convenience which creates an instance of the
CreateFolderMembershipRequest.Builderavoiding the need to create one manually viaCreateFolderMembershipRequest.builder()- Parameters:
createFolderMembershipRequest- AConsumerthat will call methods onCreateFolderMembershipRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateFolderMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createGroup
Use the
CreateGroupoperation to create a group in Quick Sight. 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 Amazon Web Services Support.The permissions resource is
arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name>.The response is a group object.
- Parameters:
createGroupRequest- The request object for this operation.- Returns:
- A Java Future containing the result of the CreateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createGroup
default CompletableFuture<CreateGroupResponse> createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest) Use the
CreateGroupoperation to create a group in Quick Sight. 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 Amazon Web Services Support.The permissions resource is
arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name>.The response is a group object.
This is a convenience which creates an instance of the
CreateGroupRequest.Builderavoiding the need to create one manually viaCreateGroupRequest.builder()- Parameters:
createGroupRequest- AConsumerthat will call methods onCreateGroupRequest.Builderto create a request. The request object for this operation.- Returns:
- A Java Future containing the result of the CreateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createGroupMembership
default CompletableFuture<CreateGroupMembershipResponse> createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest) Adds an Amazon Quick Sight user to an Amazon Quick Sight group.
- Parameters:
createGroupMembershipRequest-- Returns:
- A Java Future containing the result of the CreateGroupMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createGroupMembership
default CompletableFuture<CreateGroupMembershipResponse> createGroupMembership(Consumer<CreateGroupMembershipRequest.Builder> createGroupMembershipRequest) Adds an Amazon Quick Sight user to an Amazon Quick Sight group.
This is a convenience which creates an instance of the
CreateGroupMembershipRequest.Builderavoiding the need to create one manually viaCreateGroupMembershipRequest.builder()- Parameters:
createGroupMembershipRequest- AConsumerthat will call methods onCreateGroupMembershipRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateGroupMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createIAMPolicyAssignment
default CompletableFuture<CreateIamPolicyAssignmentResponse> createIAMPolicyAssignment(CreateIamPolicyAssignmentRequest createIamPolicyAssignmentRequest) Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon Quick Sight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.
- Parameters:
createIamPolicyAssignmentRequest-- Returns:
- A Java Future containing the result of the CreateIAMPolicyAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConcurrentUpdatingException A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createIAMPolicyAssignment
default CompletableFuture<CreateIamPolicyAssignmentResponse> createIAMPolicyAssignment(Consumer<CreateIamPolicyAssignmentRequest.Builder> createIamPolicyAssignmentRequest) Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon Quick Sight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.
This is a convenience which creates an instance of the
CreateIamPolicyAssignmentRequest.Builderavoiding the need to create one manually viaCreateIamPolicyAssignmentRequest.builder()- Parameters:
createIamPolicyAssignmentRequest- AConsumerthat will call methods onCreateIamPolicyAssignmentRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateIAMPolicyAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConcurrentUpdatingException A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createIngestion
default CompletableFuture<CreateIngestionResponse> createIngestion(CreateIngestionRequest createIngestionRequest) Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time.
Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
- Parameters:
createIngestionRequest-- Returns:
- A Java Future containing the result of the CreateIngestion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createIngestion
default CompletableFuture<CreateIngestionResponse> createIngestion(Consumer<CreateIngestionRequest.Builder> createIngestionRequest) Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time.
Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
This is a convenience which creates an instance of the
CreateIngestionRequest.Builderavoiding the need to create one manually viaCreateIngestionRequest.builder()- Parameters:
createIngestionRequest- AConsumerthat will call methods onCreateIngestionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateIngestion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createNamespace
default CompletableFuture<CreateNamespaceResponse> createNamespace(CreateNamespaceRequest createNamespaceRequest) (Enterprise edition only) Creates a new namespace for you to use with Amazon Quick Sight.
A namespace allows you to isolate the Quick Sight 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 Quick Sight. 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.
- Parameters:
createNamespaceRequest-- Returns:
- A Java Future containing the result of the CreateNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- PreconditionNotMetException One or more preconditions aren't met.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createNamespace
default CompletableFuture<CreateNamespaceResponse> createNamespace(Consumer<CreateNamespaceRequest.Builder> createNamespaceRequest) (Enterprise edition only) Creates a new namespace for you to use with Amazon Quick Sight.
A namespace allows you to isolate the Quick Sight 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 Quick Sight. 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.
This is a convenience which creates an instance of the
CreateNamespaceRequest.Builderavoiding the need to create one manually viaCreateNamespaceRequest.builder()- Parameters:
createNamespaceRequest- AConsumerthat will call methods onCreateNamespaceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- PreconditionNotMetException One or more preconditions aren't met.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRefreshSchedule
default CompletableFuture<CreateRefreshScheduleResponse> createRefreshSchedule(CreateRefreshScheduleRequest createRefreshScheduleRequest) Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
- Parameters:
createRefreshScheduleRequest-- Returns:
- A Java Future containing the result of the CreateRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRefreshSchedule
default CompletableFuture<CreateRefreshScheduleResponse> createRefreshSchedule(Consumer<CreateRefreshScheduleRequest.Builder> createRefreshScheduleRequest) Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
This is a convenience which creates an instance of the
CreateRefreshScheduleRequest.Builderavoiding the need to create one manually viaCreateRefreshScheduleRequest.builder()- Parameters:
createRefreshScheduleRequest- AConsumerthat will call methods onCreateRefreshScheduleRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRoleMembership
default CompletableFuture<CreateRoleMembershipResponse> createRoleMembership(CreateRoleMembershipRequest createRoleMembershipRequest) Use
CreateRoleMembershipto add an existing Quick Sight group to an existing role.- Parameters:
createRoleMembershipRequest-- Returns:
- A Java Future containing the result of the CreateRoleMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRoleMembership
default CompletableFuture<CreateRoleMembershipResponse> createRoleMembership(Consumer<CreateRoleMembershipRequest.Builder> createRoleMembershipRequest) Use
CreateRoleMembershipto add an existing Quick Sight group to an existing role.
This is a convenience which creates an instance of the
CreateRoleMembershipRequest.Builderavoiding the need to create one manually viaCreateRoleMembershipRequest.builder()- Parameters:
createRoleMembershipRequest- AConsumerthat will call methods onCreateRoleMembershipRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateRoleMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTemplate
default CompletableFuture<CreateTemplateResponse> createTemplate(CreateTemplateRequest createTemplateRequest) Creates a template either from a
TemplateDefinitionor from an existing Quick Sight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.A template is an entity in Quick Sight 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.
- Parameters:
createTemplateRequest-- Returns:
- A Java Future containing the result of the CreateTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTemplate
default CompletableFuture<CreateTemplateResponse> createTemplate(Consumer<CreateTemplateRequest.Builder> createTemplateRequest) Creates a template either from a
TemplateDefinitionor from an existing Quick Sight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.A template is an entity in Quick Sight 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.
This is a convenience which creates an instance of the
CreateTemplateRequest.Builderavoiding the need to create one manually viaCreateTemplateRequest.builder()- Parameters:
createTemplateRequest- AConsumerthat will call methods onCreateTemplateRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTemplateAlias
default CompletableFuture<CreateTemplateAliasResponse> createTemplateAlias(CreateTemplateAliasRequest createTemplateAliasRequest) Creates a template alias for a template.
- Parameters:
createTemplateAliasRequest-- Returns:
- A Java Future containing the result of the CreateTemplateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceExistsException The resource specified already exists.
- LimitExceededException A limit is exceeded.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTemplateAlias
default CompletableFuture<CreateTemplateAliasResponse> createTemplateAlias(Consumer<CreateTemplateAliasRequest.Builder> createTemplateAliasRequest) Creates a template alias for a template.
This is a convenience which creates an instance of the
CreateTemplateAliasRequest.Builderavoiding the need to create one manually viaCreateTemplateAliasRequest.builder()- Parameters:
createTemplateAliasRequest- AConsumerthat will call methods onCreateTemplateAliasRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateTemplateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceExistsException The resource specified already exists.
- LimitExceededException A limit is exceeded.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTheme
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 Quick Sight in the Amazon Quick Sight User Guide.
- Parameters:
createThemeRequest-- Returns:
- A Java Future containing the result of the CreateTheme operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTheme
default CompletableFuture<CreateThemeResponse> createTheme(Consumer<CreateThemeRequest.Builder> createThemeRequest) Creates a theme.
A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon Quick Sight in the Amazon Quick Sight User Guide.
This is a convenience which creates an instance of the
CreateThemeRequest.Builderavoiding the need to create one manually viaCreateThemeRequest.builder()- Parameters:
createThemeRequest- AConsumerthat will call methods onCreateThemeRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateTheme operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createThemeAlias
default CompletableFuture<CreateThemeAliasResponse> createThemeAlias(CreateThemeAliasRequest createThemeAliasRequest) Creates a theme alias for a theme.
- Parameters:
createThemeAliasRequest-- Returns:
- A Java Future containing the result of the CreateThemeAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createThemeAlias
default CompletableFuture<CreateThemeAliasResponse> createThemeAlias(Consumer<CreateThemeAliasRequest.Builder> createThemeAliasRequest) Creates a theme alias for a theme.
This is a convenience which creates an instance of the
CreateThemeAliasRequest.Builderavoiding the need to create one manually viaCreateThemeAliasRequest.builder()- Parameters:
createThemeAliasRequest- AConsumerthat will call methods onCreateThemeAliasRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateThemeAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTopic
Creates a new Q topic.
- Parameters:
createTopicRequest-- Returns:
- A Java Future containing the result of the CreateTopic operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTopic
default CompletableFuture<CreateTopicResponse> createTopic(Consumer<CreateTopicRequest.Builder> createTopicRequest) Creates a new Q topic.
This is a convenience which creates an instance of the
CreateTopicRequest.Builderavoiding the need to create one manually viaCreateTopicRequest.builder()- Parameters:
createTopicRequest- AConsumerthat will call methods onCreateTopicRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateTopic operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTopicRefreshSchedule
default CompletableFuture<CreateTopicRefreshScheduleResponse> createTopicRefreshSchedule(CreateTopicRefreshScheduleRequest createTopicRefreshScheduleRequest) Creates a topic refresh schedule.
- Parameters:
createTopicRefreshScheduleRequest-- Returns:
- A Java Future containing the result of the CreateTopicRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTopicRefreshSchedule
default CompletableFuture<CreateTopicRefreshScheduleResponse> createTopicRefreshSchedule(Consumer<CreateTopicRefreshScheduleRequest.Builder> createTopicRefreshScheduleRequest) Creates a topic refresh schedule.
This is a convenience which creates an instance of the
CreateTopicRefreshScheduleRequest.Builderavoiding the need to create one manually viaCreateTopicRefreshScheduleRequest.builder()- Parameters:
createTopicRefreshScheduleRequest- AConsumerthat will call methods onCreateTopicRefreshScheduleRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateTopicRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createVPCConnection
default CompletableFuture<CreateVpcConnectionResponse> createVPCConnection(CreateVpcConnectionRequest createVpcConnectionRequest) Creates a new VPC connection.
- Parameters:
createVpcConnectionRequest-- Returns:
- A Java Future containing the result of the CreateVPCConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createVPCConnection
default CompletableFuture<CreateVpcConnectionResponse> createVPCConnection(Consumer<CreateVpcConnectionRequest.Builder> createVpcConnectionRequest) Creates a new VPC connection.
This is a convenience which creates an instance of the
CreateVpcConnectionRequest.Builderavoiding the need to create one manually viaCreateVpcConnectionRequest.builder()- Parameters:
createVpcConnectionRequest- AConsumerthat will call methods onCreateVpcConnectionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateVPCConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAccountCustomPermission
default CompletableFuture<DeleteAccountCustomPermissionResponse> deleteAccountCustomPermission(DeleteAccountCustomPermissionRequest deleteAccountCustomPermissionRequest) Unapplies a custom permissions profile from an account.
- Parameters:
deleteAccountCustomPermissionRequest-- Returns:
- A Java Future containing the result of the DeleteAccountCustomPermission operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAccountCustomPermission
default CompletableFuture<DeleteAccountCustomPermissionResponse> deleteAccountCustomPermission(Consumer<DeleteAccountCustomPermissionRequest.Builder> deleteAccountCustomPermissionRequest) Unapplies a custom permissions profile from an account.
This is a convenience which creates an instance of the
DeleteAccountCustomPermissionRequest.Builderavoiding the need to create one manually viaDeleteAccountCustomPermissionRequest.builder()- Parameters:
deleteAccountCustomPermissionRequest- AConsumerthat will call methods onDeleteAccountCustomPermissionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteAccountCustomPermission operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAccountCustomization
default CompletableFuture<DeleteAccountCustomizationResponse> deleteAccountCustomization(DeleteAccountCustomizationRequest deleteAccountCustomizationRequest) This API permanently deletes all Quick Sight customizations for the specified Amazon Web Services account and namespace. When you delete account customizations:
-
All customizations are removed including themes, branding, and visual settings
-
This action cannot be undone through the API
-
Users will see default Quick Sight styling after customizations are deleted
Before proceeding: Ensure you have backups of any custom themes or branding elements you may want to recreate.
Deletes all Amazon Quick Sight customizations for the specified Amazon Web Services account and Quick Sight namespace.
- Parameters:
deleteAccountCustomizationRequest-- Returns:
- A Java Future containing the result of the DeleteAccountCustomization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteAccountCustomization
default CompletableFuture<DeleteAccountCustomizationResponse> deleteAccountCustomization(Consumer<DeleteAccountCustomizationRequest.Builder> deleteAccountCustomizationRequest) This API permanently deletes all Quick Sight customizations for the specified Amazon Web Services account and namespace. When you delete account customizations:
-
All customizations are removed including themes, branding, and visual settings
-
This action cannot be undone through the API
-
Users will see default Quick Sight styling after customizations are deleted
Before proceeding: Ensure you have backups of any custom themes or branding elements you may want to recreate.
Deletes all Amazon Quick Sight customizations for the specified Amazon Web Services account and Quick Sight namespace.
This is a convenience which creates an instance of the
DeleteAccountCustomizationRequest.Builderavoiding the need to create one manually viaDeleteAccountCustomizationRequest.builder()- Parameters:
deleteAccountCustomizationRequest- AConsumerthat will call methods onDeleteAccountCustomizationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteAccountCustomization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteAccountSubscription
default CompletableFuture<DeleteAccountSubscriptionResponse> deleteAccountSubscription(DeleteAccountSubscriptionRequest deleteAccountSubscriptionRequest) Deleting your Quick Sight account subscription has permanent, irreversible consequences across all Amazon Web Services regions:
-
Global deletion – Running this operation from any single region will delete your Quick Sight account and all data in every Amazon Web Services region where you have Quick Sight resources.
-
Complete data loss – All dashboards, analyses, datasets, data sources, and custom visuals will be permanently deleted across all regions.
-
Embedded content failure – All embedded dashboards and visuals in your applications will immediately stop working and display errors to end users.
-
Shared resources removed – All shared dashboards, folders, and resources will become inaccessible to other users and external recipients.
-
User access terminated – All Quick Sight users in your account will lose access immediately, including authors, readers, and administrators.
-
No recovery possible – Once deleted, your Quick Sight account and all associated data cannot be restored.
Consider exporting critical dashboards and data before proceeding with account deletion.
Use the
DeleteAccountSubscriptionoperation to delete an Quick Sight account. This operation will result in an error message if you have configured your account termination protection settings toTrue. To change this setting and delete your account, call theUpdateAccountSettingsAPI and set the value of theTerminationProtectionEnabledparameter toFalse, then make another call to theDeleteAccountSubscriptionAPI.- Parameters:
deleteAccountSubscriptionRequest-- Returns:
- A Java Future containing the result of the DeleteAccountSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteAccountSubscription
default CompletableFuture<DeleteAccountSubscriptionResponse> deleteAccountSubscription(Consumer<DeleteAccountSubscriptionRequest.Builder> deleteAccountSubscriptionRequest) Deleting your Quick Sight account subscription has permanent, irreversible consequences across all Amazon Web Services regions:
-
Global deletion – Running this operation from any single region will delete your Quick Sight account and all data in every Amazon Web Services region where you have Quick Sight resources.
-
Complete data loss – All dashboards, analyses, datasets, data sources, and custom visuals will be permanently deleted across all regions.
-
Embedded content failure – All embedded dashboards and visuals in your applications will immediately stop working and display errors to end users.
-
Shared resources removed – All shared dashboards, folders, and resources will become inaccessible to other users and external recipients.
-
User access terminated – All Quick Sight users in your account will lose access immediately, including authors, readers, and administrators.
-
No recovery possible – Once deleted, your Quick Sight account and all associated data cannot be restored.
Consider exporting critical dashboards and data before proceeding with account deletion.
Use the
DeleteAccountSubscriptionoperation to delete an Quick Sight account. This operation will result in an error message if you have configured your account termination protection settings toTrue. To change this setting and delete your account, call theUpdateAccountSettingsAPI and set the value of theTerminationProtectionEnabledparameter toFalse, then make another call to theDeleteAccountSubscriptionAPI.
This is a convenience which creates an instance of the
DeleteAccountSubscriptionRequest.Builderavoiding the need to create one manually viaDeleteAccountSubscriptionRequest.builder()- Parameters:
deleteAccountSubscriptionRequest- AConsumerthat will call methods onDeleteAccountSubscriptionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteAccountSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteActionConnector
default CompletableFuture<DeleteActionConnectorResponse> deleteActionConnector(DeleteActionConnectorRequest deleteActionConnectorRequest) Hard deletes an action connector, making it unrecoverable. This operation removes the connector and all its associated configurations. Any resources currently using this action connector will no longer be able to perform actions through it.
- Parameters:
deleteActionConnectorRequest-- Returns:
- A Java Future containing the result of the DeleteActionConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- ResourceNotFoundException One or more resources can't be found.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteActionConnector
default CompletableFuture<DeleteActionConnectorResponse> deleteActionConnector(Consumer<DeleteActionConnectorRequest.Builder> deleteActionConnectorRequest) Hard deletes an action connector, making it unrecoverable. This operation removes the connector and all its associated configurations. Any resources currently using this action connector will no longer be able to perform actions through it.
This is a convenience which creates an instance of the
DeleteActionConnectorRequest.Builderavoiding the need to create one manually viaDeleteActionConnectorRequest.builder()- Parameters:
deleteActionConnectorRequest- AConsumerthat will call methods onDeleteActionConnectorRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteActionConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- ResourceNotFoundException One or more resources can't be found.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAnalysis
default CompletableFuture<DeleteAnalysisResponse> deleteAnalysis(DeleteAnalysisRequest deleteAnalysisRequest) Deletes an analysis from Amazon Quick Sight. 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 Quick Sight attaches a
DeletionTimestamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon Quick Sight deletes the analysis permanently.At any time before recovery window ends, you can use the
RestoreAnalysisAPI operation to remove theDeletionTimestamp 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 Quick Sight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
- Parameters:
deleteAnalysisRequest-- Returns:
- A Java Future containing the result of the DeleteAnalysis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAnalysis
default CompletableFuture<DeleteAnalysisResponse> deleteAnalysis(Consumer<DeleteAnalysisRequest.Builder> deleteAnalysisRequest) Deletes an analysis from Amazon Quick Sight. 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 Quick Sight attaches a
DeletionTimestamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon Quick Sight deletes the analysis permanently.At any time before recovery window ends, you can use the
RestoreAnalysisAPI operation to remove theDeletionTimestamp 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 Quick Sight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
This is a convenience which creates an instance of the
DeleteAnalysisRequest.Builderavoiding the need to create one manually viaDeleteAnalysisRequest.builder()- Parameters:
deleteAnalysisRequest- AConsumerthat will call methods onDeleteAnalysisRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteAnalysis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBrand
This API permanently deletes the specified Quick Sight brand. When you delete a brand:
-
The brand and all its associated branding elements are permanently removed
-
Any applications or dashboards using this brand will revert to default styling
-
This action cannot be undone through the API
Before proceeding: Verify that the brand is no longer needed and consider the impact on any applications currently using this brand.
Deletes an Quick Sight brand.
- Parameters:
deleteBrandRequest-- Returns:
- A Java Future containing the result of the DeleteBrand operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InternalServerException An internal service exception.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteBrand
default CompletableFuture<DeleteBrandResponse> deleteBrand(Consumer<DeleteBrandRequest.Builder> deleteBrandRequest) This API permanently deletes the specified Quick Sight brand. When you delete a brand:
-
The brand and all its associated branding elements are permanently removed
-
Any applications or dashboards using this brand will revert to default styling
-
This action cannot be undone through the API
Before proceeding: Verify that the brand is no longer needed and consider the impact on any applications currently using this brand.
Deletes an Quick Sight brand.
This is a convenience which creates an instance of the
DeleteBrandRequest.Builderavoiding the need to create one manually viaDeleteBrandRequest.builder()- Parameters:
deleteBrandRequest- AConsumerthat will call methods onDeleteBrandRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteBrand operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InternalServerException An internal service exception.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteBrandAssignment
default CompletableFuture<DeleteBrandAssignmentResponse> deleteBrandAssignment(DeleteBrandAssignmentRequest deleteBrandAssignmentRequest) Deletes a brand assignment.
- Parameters:
deleteBrandAssignmentRequest-- Returns:
- A Java Future containing the result of the DeleteBrandAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InternalServerException An internal service exception.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBrandAssignment
default CompletableFuture<DeleteBrandAssignmentResponse> deleteBrandAssignment(Consumer<DeleteBrandAssignmentRequest.Builder> deleteBrandAssignmentRequest) Deletes a brand assignment.
This is a convenience which creates an instance of the
DeleteBrandAssignmentRequest.Builderavoiding the need to create one manually viaDeleteBrandAssignmentRequest.builder()- Parameters:
deleteBrandAssignmentRequest- AConsumerthat will call methods onDeleteBrandAssignmentRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteBrandAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InternalServerException An internal service exception.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCustomPermissions
default CompletableFuture<DeleteCustomPermissionsResponse> deleteCustomPermissions(DeleteCustomPermissionsRequest deleteCustomPermissionsRequest) Deletes a custom permissions profile.
- Parameters:
deleteCustomPermissionsRequest-- Returns:
- A Java Future containing the result of the DeleteCustomPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCustomPermissions
default CompletableFuture<DeleteCustomPermissionsResponse> deleteCustomPermissions(Consumer<DeleteCustomPermissionsRequest.Builder> deleteCustomPermissionsRequest) Deletes a custom permissions profile.
This is a convenience which creates an instance of the
DeleteCustomPermissionsRequest.Builderavoiding the need to create one manually viaDeleteCustomPermissionsRequest.builder()- Parameters:
deleteCustomPermissionsRequest- AConsumerthat will call methods onDeleteCustomPermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteCustomPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDashboard
default CompletableFuture<DeleteDashboardResponse> deleteDashboard(DeleteDashboardRequest deleteDashboardRequest) Deletes a dashboard.
- Parameters:
deleteDashboardRequest-- Returns:
- A Java Future containing the result of the DeleteDashboard operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDashboard
default CompletableFuture<DeleteDashboardResponse> deleteDashboard(Consumer<DeleteDashboardRequest.Builder> deleteDashboardRequest) Deletes a dashboard.
This is a convenience which creates an instance of the
DeleteDashboardRequest.Builderavoiding the need to create one manually viaDeleteDashboardRequest.builder()- Parameters:
deleteDashboardRequest- AConsumerthat will call methods onDeleteDashboardRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteDashboard operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDataSet
default CompletableFuture<DeleteDataSetResponse> deleteDataSet(DeleteDataSetRequest deleteDataSetRequest) Deletes a dataset.
- Parameters:
deleteDataSetRequest-- Returns:
- A Java Future containing the result of the DeleteDataSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDataSet
default CompletableFuture<DeleteDataSetResponse> deleteDataSet(Consumer<DeleteDataSetRequest.Builder> deleteDataSetRequest) Deletes a dataset.
This is a convenience which creates an instance of the
DeleteDataSetRequest.Builderavoiding the need to create one manually viaDeleteDataSetRequest.builder()- Parameters:
deleteDataSetRequest- AConsumerthat will call methods onDeleteDataSetRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteDataSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDataSetRefreshProperties
default CompletableFuture<DeleteDataSetRefreshPropertiesResponse> deleteDataSetRefreshProperties(DeleteDataSetRefreshPropertiesRequest deleteDataSetRefreshPropertiesRequest) Deletes the dataset refresh properties of the dataset.
- Parameters:
deleteDataSetRefreshPropertiesRequest-- Returns:
- A Java Future containing the result of the DeleteDataSetRefreshProperties operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDataSetRefreshProperties
default CompletableFuture<DeleteDataSetRefreshPropertiesResponse> deleteDataSetRefreshProperties(Consumer<DeleteDataSetRefreshPropertiesRequest.Builder> deleteDataSetRefreshPropertiesRequest) Deletes the dataset refresh properties of the dataset.
This is a convenience which creates an instance of the
DeleteDataSetRefreshPropertiesRequest.Builderavoiding the need to create one manually viaDeleteDataSetRefreshPropertiesRequest.builder()- Parameters:
deleteDataSetRefreshPropertiesRequest- AConsumerthat will call methods onDeleteDataSetRefreshPropertiesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteDataSetRefreshProperties operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDataSource
default CompletableFuture<DeleteDataSourceResponse> deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest) Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
- Parameters:
deleteDataSourceRequest-- Returns:
- A Java Future containing the result of the DeleteDataSource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDataSource
default CompletableFuture<DeleteDataSourceResponse> deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest) Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
This is a convenience which creates an instance of the
DeleteDataSourceRequest.Builderavoiding the need to create one manually viaDeleteDataSourceRequest.builder()- Parameters:
deleteDataSourceRequest- AConsumerthat will call methods onDeleteDataSourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteDataSource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDefaultQBusinessApplication
default CompletableFuture<DeleteDefaultQBusinessApplicationResponse> deleteDefaultQBusinessApplication(DeleteDefaultQBusinessApplicationRequest deleteDefaultQBusinessApplicationRequest) Deletes a linked Amazon Q Business application from an Quick Sight account
- Parameters:
deleteDefaultQBusinessApplicationRequest-- Returns:
- A Java Future containing the result of the DeleteDefaultQBusinessApplication operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDefaultQBusinessApplication
default CompletableFuture<DeleteDefaultQBusinessApplicationResponse> deleteDefaultQBusinessApplication(Consumer<DeleteDefaultQBusinessApplicationRequest.Builder> deleteDefaultQBusinessApplicationRequest) Deletes a linked Amazon Q Business application from an Quick Sight account
This is a convenience which creates an instance of the
DeleteDefaultQBusinessApplicationRequest.Builderavoiding the need to create one manually viaDeleteDefaultQBusinessApplicationRequest.builder()- Parameters:
deleteDefaultQBusinessApplicationRequest- AConsumerthat will call methods onDeleteDefaultQBusinessApplicationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteDefaultQBusinessApplication operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteFolder
default CompletableFuture<DeleteFolderResponse> deleteFolder(DeleteFolderRequest deleteFolderRequest) Deletes an empty folder.
- Parameters:
deleteFolderRequest-- Returns:
- A Java Future containing the result of the DeleteFolder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- PreconditionNotMetException One or more preconditions aren't met.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteFolder
default CompletableFuture<DeleteFolderResponse> deleteFolder(Consumer<DeleteFolderRequest.Builder> deleteFolderRequest) Deletes an empty folder.
This is a convenience which creates an instance of the
DeleteFolderRequest.Builderavoiding the need to create one manually viaDeleteFolderRequest.builder()- Parameters:
deleteFolderRequest- AConsumerthat will call methods onDeleteFolderRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteFolder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- PreconditionNotMetException One or more preconditions aren't met.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteFolderMembership
default CompletableFuture<DeleteFolderMembershipResponse> deleteFolderMembership(DeleteFolderMembershipRequest deleteFolderMembershipRequest) Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
- Parameters:
deleteFolderMembershipRequest-- Returns:
- A Java Future containing the result of the DeleteFolderMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteFolderMembership
default CompletableFuture<DeleteFolderMembershipResponse> deleteFolderMembership(Consumer<DeleteFolderMembershipRequest.Builder> deleteFolderMembershipRequest) Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
This is a convenience which creates an instance of the
DeleteFolderMembershipRequest.Builderavoiding the need to create one manually viaDeleteFolderMembershipRequest.builder()- Parameters:
deleteFolderMembershipRequest- AConsumerthat will call methods onDeleteFolderMembershipRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteFolderMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteGroup
Removes a user group from Amazon Quick Sight.
- Parameters:
deleteGroupRequest-- Returns:
- A Java Future containing the result of the DeleteGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteGroup
default CompletableFuture<DeleteGroupResponse> deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) Removes a user group from Amazon Quick Sight.
This is a convenience which creates an instance of the
DeleteGroupRequest.Builderavoiding the need to create one manually viaDeleteGroupRequest.builder()- Parameters:
deleteGroupRequest- AConsumerthat will call methods onDeleteGroupRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteGroupMembership
default CompletableFuture<DeleteGroupMembershipResponse> deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest) Removes a user from a group so that the user is no longer a member of the group.
- Parameters:
deleteGroupMembershipRequest-- Returns:
- A Java Future containing the result of the DeleteGroupMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteGroupMembership
default CompletableFuture<DeleteGroupMembershipResponse> deleteGroupMembership(Consumer<DeleteGroupMembershipRequest.Builder> deleteGroupMembershipRequest) Removes a user from a group so that the user is no longer a member of the group.
This is a convenience which creates an instance of the
DeleteGroupMembershipRequest.Builderavoiding the need to create one manually viaDeleteGroupMembershipRequest.builder()- Parameters:
deleteGroupMembershipRequest- AConsumerthat will call methods onDeleteGroupMembershipRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteGroupMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIAMPolicyAssignment
default CompletableFuture<DeleteIamPolicyAssignmentResponse> deleteIAMPolicyAssignment(DeleteIamPolicyAssignmentRequest deleteIamPolicyAssignmentRequest) Deletes an existing IAM policy assignment.
- Parameters:
deleteIamPolicyAssignmentRequest-- Returns:
- A Java Future containing the result of the DeleteIAMPolicyAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConcurrentUpdatingException A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIAMPolicyAssignment
default CompletableFuture<DeleteIamPolicyAssignmentResponse> deleteIAMPolicyAssignment(Consumer<DeleteIamPolicyAssignmentRequest.Builder> deleteIamPolicyAssignmentRequest) Deletes an existing IAM policy assignment.
This is a convenience which creates an instance of the
DeleteIamPolicyAssignmentRequest.Builderavoiding the need to create one manually viaDeleteIamPolicyAssignmentRequest.builder()- Parameters:
deleteIamPolicyAssignmentRequest- AConsumerthat will call methods onDeleteIamPolicyAssignmentRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteIAMPolicyAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConcurrentUpdatingException A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIdentityPropagationConfig
default CompletableFuture<DeleteIdentityPropagationConfigResponse> deleteIdentityPropagationConfig(DeleteIdentityPropagationConfigRequest deleteIdentityPropagationConfigRequest) Deletes all access scopes and authorized targets that are associated with a service from the Quick Sight IAM Identity Center application.
This operation is only supported for Quick Sight accounts that use IAM Identity Center.
- Parameters:
deleteIdentityPropagationConfigRequest-- Returns:
- A Java Future containing the result of the DeleteIdentityPropagationConfig operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIdentityPropagationConfig
default CompletableFuture<DeleteIdentityPropagationConfigResponse> deleteIdentityPropagationConfig(Consumer<DeleteIdentityPropagationConfigRequest.Builder> deleteIdentityPropagationConfigRequest) Deletes all access scopes and authorized targets that are associated with a service from the Quick Sight IAM Identity Center application.
This operation is only supported for Quick Sight accounts that use IAM Identity Center.
This is a convenience which creates an instance of the
DeleteIdentityPropagationConfigRequest.Builderavoiding the need to create one manually viaDeleteIdentityPropagationConfigRequest.builder()- Parameters:
deleteIdentityPropagationConfigRequest- AConsumerthat will call methods onDeleteIdentityPropagationConfigRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteIdentityPropagationConfig operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteNamespace
default CompletableFuture<DeleteNamespaceResponse> deleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest) Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.
- Parameters:
deleteNamespaceRequest-- Returns:
- A Java Future containing the result of the DeleteNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteNamespace
default CompletableFuture<DeleteNamespaceResponse> deleteNamespace(Consumer<DeleteNamespaceRequest.Builder> deleteNamespaceRequest) Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.
This is a convenience which creates an instance of the
DeleteNamespaceRequest.Builderavoiding the need to create one manually viaDeleteNamespaceRequest.builder()- Parameters:
deleteNamespaceRequest- AConsumerthat will call methods onDeleteNamespaceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRefreshSchedule
default CompletableFuture<DeleteRefreshScheduleResponse> deleteRefreshSchedule(DeleteRefreshScheduleRequest deleteRefreshScheduleRequest) Deletes a refresh schedule from a dataset.
- Parameters:
deleteRefreshScheduleRequest-- Returns:
- A Java Future containing the result of the DeleteRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRefreshSchedule
default CompletableFuture<DeleteRefreshScheduleResponse> deleteRefreshSchedule(Consumer<DeleteRefreshScheduleRequest.Builder> deleteRefreshScheduleRequest) Deletes a refresh schedule from a dataset.
This is a convenience which creates an instance of the
DeleteRefreshScheduleRequest.Builderavoiding the need to create one manually viaDeleteRefreshScheduleRequest.builder()- Parameters:
deleteRefreshScheduleRequest- AConsumerthat will call methods onDeleteRefreshScheduleRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRoleCustomPermission
default CompletableFuture<DeleteRoleCustomPermissionResponse> deleteRoleCustomPermission(DeleteRoleCustomPermissionRequest deleteRoleCustomPermissionRequest) Removes custom permissions from the role.
- Parameters:
deleteRoleCustomPermissionRequest-- Returns:
- A Java Future containing the result of the DeleteRoleCustomPermission operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRoleCustomPermission
default CompletableFuture<DeleteRoleCustomPermissionResponse> deleteRoleCustomPermission(Consumer<DeleteRoleCustomPermissionRequest.Builder> deleteRoleCustomPermissionRequest) Removes custom permissions from the role.
This is a convenience which creates an instance of the
DeleteRoleCustomPermissionRequest.Builderavoiding the need to create one manually viaDeleteRoleCustomPermissionRequest.builder()- Parameters:
deleteRoleCustomPermissionRequest- AConsumerthat will call methods onDeleteRoleCustomPermissionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteRoleCustomPermission operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRoleMembership
default CompletableFuture<DeleteRoleMembershipResponse> deleteRoleMembership(DeleteRoleMembershipRequest deleteRoleMembershipRequest) Removes a group from a role.
- Parameters:
deleteRoleMembershipRequest-- Returns:
- A Java Future containing the result of the DeleteRoleMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRoleMembership
default CompletableFuture<DeleteRoleMembershipResponse> deleteRoleMembership(Consumer<DeleteRoleMembershipRequest.Builder> deleteRoleMembershipRequest) Removes a group from a role.
This is a convenience which creates an instance of the
DeleteRoleMembershipRequest.Builderavoiding the need to create one manually viaDeleteRoleMembershipRequest.builder()- Parameters:
deleteRoleMembershipRequest- AConsumerthat will call methods onDeleteRoleMembershipRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteRoleMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTemplate
default CompletableFuture<DeleteTemplateResponse> deleteTemplate(DeleteTemplateRequest deleteTemplateRequest) Deletes a template.
- Parameters:
deleteTemplateRequest-- Returns:
- A Java Future containing the result of the DeleteTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- LimitExceededException A limit is exceeded.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTemplate
default CompletableFuture<DeleteTemplateResponse> deleteTemplate(Consumer<DeleteTemplateRequest.Builder> deleteTemplateRequest) Deletes a template.
This is a convenience which creates an instance of the
DeleteTemplateRequest.Builderavoiding the need to create one manually viaDeleteTemplateRequest.builder()- Parameters:
deleteTemplateRequest- AConsumerthat will call methods onDeleteTemplateRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- LimitExceededException A limit is exceeded.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTemplateAlias
default CompletableFuture<DeleteTemplateAliasResponse> deleteTemplateAlias(DeleteTemplateAliasRequest deleteTemplateAliasRequest) Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
- Parameters:
deleteTemplateAliasRequest-- Returns:
- A Java Future containing the result of the DeleteTemplateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTemplateAlias
default CompletableFuture<DeleteTemplateAliasResponse> deleteTemplateAlias(Consumer<DeleteTemplateAliasRequest.Builder> deleteTemplateAliasRequest) Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
This is a convenience which creates an instance of the
DeleteTemplateAliasRequest.Builderavoiding the need to create one manually viaDeleteTemplateAliasRequest.builder()- Parameters:
deleteTemplateAliasRequest- AConsumerthat will call methods onDeleteTemplateAliasRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteTemplateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTheme
Deletes a theme.
- Parameters:
deleteThemeRequest-- Returns:
- A Java Future containing the result of the DeleteTheme operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTheme
default CompletableFuture<DeleteThemeResponse> deleteTheme(Consumer<DeleteThemeRequest.Builder> deleteThemeRequest) Deletes a theme.
This is a convenience which creates an instance of the
DeleteThemeRequest.Builderavoiding the need to create one manually viaDeleteThemeRequest.builder()- Parameters:
deleteThemeRequest- AConsumerthat will call methods onDeleteThemeRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteTheme operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteThemeAlias
default CompletableFuture<DeleteThemeAliasResponse> deleteThemeAlias(DeleteThemeAliasRequest deleteThemeAliasRequest) Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.
- Parameters:
deleteThemeAliasRequest-- Returns:
- A Java Future containing the result of the DeleteThemeAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteThemeAlias
default CompletableFuture<DeleteThemeAliasResponse> deleteThemeAlias(Consumer<DeleteThemeAliasRequest.Builder> deleteThemeAliasRequest) Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.
This is a convenience which creates an instance of the
DeleteThemeAliasRequest.Builderavoiding the need to create one manually viaDeleteThemeAliasRequest.builder()- Parameters:
deleteThemeAliasRequest- AConsumerthat will call methods onDeleteThemeAliasRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteThemeAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTopic
Deletes a topic.
- Parameters:
deleteTopicRequest-- Returns:
- A Java Future containing the result of the DeleteTopic operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTopic
default CompletableFuture<DeleteTopicResponse> deleteTopic(Consumer<DeleteTopicRequest.Builder> deleteTopicRequest) Deletes a topic.
This is a convenience which creates an instance of the
DeleteTopicRequest.Builderavoiding the need to create one manually viaDeleteTopicRequest.builder()- Parameters:
deleteTopicRequest- AConsumerthat will call methods onDeleteTopicRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteTopic operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTopicRefreshSchedule
default CompletableFuture<DeleteTopicRefreshScheduleResponse> deleteTopicRefreshSchedule(DeleteTopicRefreshScheduleRequest deleteTopicRefreshScheduleRequest) Deletes a topic refresh schedule.
- Parameters:
deleteTopicRefreshScheduleRequest-- Returns:
- A Java Future containing the result of the DeleteTopicRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTopicRefreshSchedule
default CompletableFuture<DeleteTopicRefreshScheduleResponse> deleteTopicRefreshSchedule(Consumer<DeleteTopicRefreshScheduleRequest.Builder> deleteTopicRefreshScheduleRequest) Deletes a topic refresh schedule.
This is a convenience which creates an instance of the
DeleteTopicRefreshScheduleRequest.Builderavoiding the need to create one manually viaDeleteTopicRefreshScheduleRequest.builder()- Parameters:
deleteTopicRefreshScheduleRequest- AConsumerthat will call methods onDeleteTopicRefreshScheduleRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteTopicRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteUser
Deletes the Amazon Quick Sight 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.
- Parameters:
deleteUserRequest-- Returns:
- A Java Future containing the result of the DeleteUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteUser
default CompletableFuture<DeleteUserResponse> deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) Deletes the Amazon Quick Sight 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.
This is a convenience which creates an instance of the
DeleteUserRequest.Builderavoiding the need to create one manually viaDeleteUserRequest.builder()- Parameters:
deleteUserRequest- AConsumerthat will call methods onDeleteUserRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteUserByPrincipalId
default CompletableFuture<DeleteUserByPrincipalIdResponse> deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest deleteUserByPrincipalIdRequest) Deletes a user identified by its principal ID.
- Parameters:
deleteUserByPrincipalIdRequest-- Returns:
- A Java Future containing the result of the DeleteUserByPrincipalId operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteUserByPrincipalId
default CompletableFuture<DeleteUserByPrincipalIdResponse> deleteUserByPrincipalId(Consumer<DeleteUserByPrincipalIdRequest.Builder> deleteUserByPrincipalIdRequest) Deletes a user identified by its principal ID.
This is a convenience which creates an instance of the
DeleteUserByPrincipalIdRequest.Builderavoiding the need to create one manually viaDeleteUserByPrincipalIdRequest.builder()- Parameters:
deleteUserByPrincipalIdRequest- AConsumerthat will call methods onDeleteUserByPrincipalIdRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteUserByPrincipalId operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteUserCustomPermission
default CompletableFuture<DeleteUserCustomPermissionResponse> deleteUserCustomPermission(DeleteUserCustomPermissionRequest deleteUserCustomPermissionRequest) Deletes a custom permissions profile from a user.
- Parameters:
deleteUserCustomPermissionRequest-- Returns:
- A Java Future containing the result of the DeleteUserCustomPermission operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteUserCustomPermission
default CompletableFuture<DeleteUserCustomPermissionResponse> deleteUserCustomPermission(Consumer<DeleteUserCustomPermissionRequest.Builder> deleteUserCustomPermissionRequest) Deletes a custom permissions profile from a user.
This is a convenience which creates an instance of the
DeleteUserCustomPermissionRequest.Builderavoiding the need to create one manually viaDeleteUserCustomPermissionRequest.builder()- Parameters:
deleteUserCustomPermissionRequest- AConsumerthat will call methods onDeleteUserCustomPermissionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteUserCustomPermission operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVPCConnection
default CompletableFuture<DeleteVpcConnectionResponse> deleteVPCConnection(DeleteVpcConnectionRequest deleteVpcConnectionRequest) Deletes a VPC connection.
- Parameters:
deleteVpcConnectionRequest-- Returns:
- A Java Future containing the result of the DeleteVPCConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVPCConnection
default CompletableFuture<DeleteVpcConnectionResponse> deleteVPCConnection(Consumer<DeleteVpcConnectionRequest.Builder> deleteVpcConnectionRequest) Deletes a VPC connection.
This is a convenience which creates an instance of the
DeleteVpcConnectionRequest.Builderavoiding the need to create one manually viaDeleteVpcConnectionRequest.builder()- Parameters:
deleteVpcConnectionRequest- AConsumerthat will call methods onDeleteVpcConnectionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteVPCConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccountCustomPermission
default CompletableFuture<DescribeAccountCustomPermissionResponse> describeAccountCustomPermission(DescribeAccountCustomPermissionRequest describeAccountCustomPermissionRequest) Describes the custom permissions profile that is applied to an account.
- Parameters:
describeAccountCustomPermissionRequest-- Returns:
- A Java Future containing the result of the DescribeAccountCustomPermission operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccountCustomPermission
default CompletableFuture<DescribeAccountCustomPermissionResponse> describeAccountCustomPermission(Consumer<DescribeAccountCustomPermissionRequest.Builder> describeAccountCustomPermissionRequest) Describes the custom permissions profile that is applied to an account.
This is a convenience which creates an instance of the
DescribeAccountCustomPermissionRequest.Builderavoiding the need to create one manually viaDescribeAccountCustomPermissionRequest.builder()- Parameters:
describeAccountCustomPermissionRequest- AConsumerthat will call methods onDescribeAccountCustomPermissionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeAccountCustomPermission operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccountCustomization
default CompletableFuture<DescribeAccountCustomizationResponse> describeAccountCustomization(DescribeAccountCustomizationRequest describeAccountCustomizationRequest) Describes the customizations associated with the provided Amazon Web Services account and Amazon Quick Sight namespace. The Quick Sight console evaluates which customizations to apply by running this API operation with the
Resolvedflag 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 Quick Sight, 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 Quick Sight in any supported Amazon Web Services Region. -
Amazon Web Services Region- You can sign in to Quick Sight in any Amazon Web Services Region. If you have a user directory, it resides in us-east-1, which is US East (N. Virginia). Generally speaking, these users have access to Quick Sight 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 configureto 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 Quick Sight 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- Quick Sight 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.
- Parameters:
describeAccountCustomizationRequest-- Returns:
- A Java Future containing the result of the DescribeAccountCustomization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeAccountCustomization
default CompletableFuture<DescribeAccountCustomizationResponse> describeAccountCustomization(Consumer<DescribeAccountCustomizationRequest.Builder> describeAccountCustomizationRequest) Describes the customizations associated with the provided Amazon Web Services account and Amazon Quick Sight namespace. The Quick Sight console evaluates which customizations to apply by running this API operation with the
Resolvedflag 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 Quick Sight, 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 Quick Sight in any supported Amazon Web Services Region. -
Amazon Web Services Region- You can sign in to Quick Sight in any Amazon Web Services Region. If you have a user directory, it resides in us-east-1, which is US East (N. Virginia). Generally speaking, these users have access to Quick Sight 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 configureto 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 Quick Sight 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- Quick Sight 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.
This is a convenience which creates an instance of the
DescribeAccountCustomizationRequest.Builderavoiding the need to create one manually viaDescribeAccountCustomizationRequest.builder()- Parameters:
describeAccountCustomizationRequest- AConsumerthat will call methods onDescribeAccountCustomizationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeAccountCustomization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeAccountSettings
default CompletableFuture<DescribeAccountSettingsResponse> describeAccountSettings(DescribeAccountSettingsRequest describeAccountSettingsRequest) Describes the settings that were used when your Quick Sight subscription was first created in this Amazon Web Services account.
- Parameters:
describeAccountSettingsRequest-- Returns:
- A Java Future containing the result of the DescribeAccountSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccountSettings
default CompletableFuture<DescribeAccountSettingsResponse> describeAccountSettings(Consumer<DescribeAccountSettingsRequest.Builder> describeAccountSettingsRequest) Describes the settings that were used when your Quick Sight subscription was first created in this Amazon Web Services account.
This is a convenience which creates an instance of the
DescribeAccountSettingsRequest.Builderavoiding the need to create one manually viaDescribeAccountSettingsRequest.builder()- Parameters:
describeAccountSettingsRequest- AConsumerthat will call methods onDescribeAccountSettingsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeAccountSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccountSubscription
default CompletableFuture<DescribeAccountSubscriptionResponse> describeAccountSubscription(DescribeAccountSubscriptionRequest describeAccountSubscriptionRequest) Use the DescribeAccountSubscription operation to receive a description of an Quick Sight account's subscription. A successful API call returns an
AccountInfoobject that includes an account's name, subscription status, authentication type, edition, and notification email address.- Parameters:
describeAccountSubscriptionRequest-- Returns:
- A Java Future containing the result of the DescribeAccountSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAccountSubscription
default CompletableFuture<DescribeAccountSubscriptionResponse> describeAccountSubscription(Consumer<DescribeAccountSubscriptionRequest.Builder> describeAccountSubscriptionRequest) Use the DescribeAccountSubscription operation to receive a description of an Quick Sight account's subscription. A successful API call returns an
AccountInfoobject that includes an account's name, subscription status, authentication type, edition, and notification email address.
This is a convenience which creates an instance of the
DescribeAccountSubscriptionRequest.Builderavoiding the need to create one manually viaDescribeAccountSubscriptionRequest.builder()- Parameters:
describeAccountSubscriptionRequest- AConsumerthat will call methods onDescribeAccountSubscriptionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeAccountSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeActionConnector
default CompletableFuture<DescribeActionConnectorResponse> describeActionConnector(DescribeActionConnectorRequest describeActionConnectorRequest) Retrieves detailed information about an action connector, including its configuration, authentication settings, enabled actions, and current status.
- Parameters:
describeActionConnectorRequest-- Returns:
- A Java Future containing the result of the DescribeActionConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- ResourceNotFoundException One or more resources can't be found.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeActionConnector
default CompletableFuture<DescribeActionConnectorResponse> describeActionConnector(Consumer<DescribeActionConnectorRequest.Builder> describeActionConnectorRequest) Retrieves detailed information about an action connector, including its configuration, authentication settings, enabled actions, and current status.
This is a convenience which creates an instance of the
DescribeActionConnectorRequest.Builderavoiding the need to create one manually viaDescribeActionConnectorRequest.builder()- Parameters:
describeActionConnectorRequest- AConsumerthat will call methods onDescribeActionConnectorRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeActionConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- ResourceNotFoundException One or more resources can't be found.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeActionConnectorPermissions
default CompletableFuture<DescribeActionConnectorPermissionsResponse> describeActionConnectorPermissions(DescribeActionConnectorPermissionsRequest describeActionConnectorPermissionsRequest) Retrieves the permissions configuration for an action connector, showing which users, groups, and namespaces have access and what operations they can perform.
- Parameters:
describeActionConnectorPermissionsRequest-- Returns:
- A Java Future containing the result of the DescribeActionConnectorPermissions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- ResourceNotFoundException One or more resources can't be found.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeActionConnectorPermissions
default CompletableFuture<DescribeActionConnectorPermissionsResponse> describeActionConnectorPermissions(Consumer<DescribeActionConnectorPermissionsRequest.Builder> describeActionConnectorPermissionsRequest) Retrieves the permissions configuration for an action connector, showing which users, groups, and namespaces have access and what operations they can perform.
This is a convenience which creates an instance of the
DescribeActionConnectorPermissionsRequest.Builderavoiding the need to create one manually viaDescribeActionConnectorPermissionsRequest.builder()- Parameters:
describeActionConnectorPermissionsRequest- AConsumerthat will call methods onDescribeActionConnectorPermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeActionConnectorPermissions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- ResourceNotFoundException One or more resources can't be found.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAnalysis
default CompletableFuture<DescribeAnalysisResponse> describeAnalysis(DescribeAnalysisRequest describeAnalysisRequest) Provides a summary of the metadata for an analysis.
- Parameters:
describeAnalysisRequest-- Returns:
- A Java Future containing the result of the DescribeAnalysis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAnalysis
default CompletableFuture<DescribeAnalysisResponse> describeAnalysis(Consumer<DescribeAnalysisRequest.Builder> describeAnalysisRequest) Provides a summary of the metadata for an analysis.
This is a convenience which creates an instance of the
DescribeAnalysisRequest.Builderavoiding the need to create one manually viaDescribeAnalysisRequest.builder()- Parameters:
describeAnalysisRequest- AConsumerthat will call methods onDescribeAnalysisRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeAnalysis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAnalysisDefinition
default CompletableFuture<DescribeAnalysisDefinitionResponse> describeAnalysisDefinition(DescribeAnalysisDefinitionRequest describeAnalysisDefinitionRequest) Provides a detailed description of the definition of an analysis.
If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the
DescribeAnalysisinstead.- Parameters:
describeAnalysisDefinitionRequest-- Returns:
- A Java Future containing the result of the DescribeAnalysisDefinition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAnalysisDefinition
default CompletableFuture<DescribeAnalysisDefinitionResponse> describeAnalysisDefinition(Consumer<DescribeAnalysisDefinitionRequest.Builder> describeAnalysisDefinitionRequest) Provides a detailed description of the definition of an analysis.
If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the
DescribeAnalysisinstead.
This is a convenience which creates an instance of the
DescribeAnalysisDefinitionRequest.Builderavoiding the need to create one manually viaDescribeAnalysisDefinitionRequest.builder()- Parameters:
describeAnalysisDefinitionRequest- AConsumerthat will call methods onDescribeAnalysisDefinitionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeAnalysisDefinition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAnalysisPermissions
default CompletableFuture<DescribeAnalysisPermissionsResponse> describeAnalysisPermissions(DescribeAnalysisPermissionsRequest describeAnalysisPermissionsRequest) Provides the read and write permissions for an analysis.
- Parameters:
describeAnalysisPermissionsRequest-- Returns:
- A Java Future containing the result of the DescribeAnalysisPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAnalysisPermissions
default CompletableFuture<DescribeAnalysisPermissionsResponse> describeAnalysisPermissions(Consumer<DescribeAnalysisPermissionsRequest.Builder> describeAnalysisPermissionsRequest) Provides the read and write permissions for an analysis.
This is a convenience which creates an instance of the
DescribeAnalysisPermissionsRequest.Builderavoiding the need to create one manually viaDescribeAnalysisPermissionsRequest.builder()- Parameters:
describeAnalysisPermissionsRequest- AConsumerthat will call methods onDescribeAnalysisPermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeAnalysisPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAssetBundleExportJob
default CompletableFuture<DescribeAssetBundleExportJobResponse> describeAssetBundleExportJob(DescribeAssetBundleExportJobRequest describeAssetBundleExportJobRequest) Describes an existing export job.
Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the
DescribeAssetBundleExportJobAPI for a new download URL as needed.Job descriptions are available for 14 days after the job starts.
- Parameters:
describeAssetBundleExportJobRequest-- Returns:
- A Java Future containing the result of the DescribeAssetBundleExportJob operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAssetBundleExportJob
default CompletableFuture<DescribeAssetBundleExportJobResponse> describeAssetBundleExportJob(Consumer<DescribeAssetBundleExportJobRequest.Builder> describeAssetBundleExportJobRequest) Describes an existing export job.
Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the
DescribeAssetBundleExportJobAPI for a new download URL as needed.Job descriptions are available for 14 days after the job starts.
This is a convenience which creates an instance of the
DescribeAssetBundleExportJobRequest.Builderavoiding the need to create one manually viaDescribeAssetBundleExportJobRequest.builder()- Parameters:
describeAssetBundleExportJobRequest- AConsumerthat will call methods onDescribeAssetBundleExportJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeAssetBundleExportJob operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAssetBundleImportJob
default CompletableFuture<DescribeAssetBundleImportJobResponse> describeAssetBundleImportJob(DescribeAssetBundleImportJobRequest describeAssetBundleImportJobRequest) Describes an existing import job.
Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.
- Parameters:
describeAssetBundleImportJobRequest-- Returns:
- A Java Future containing the result of the DescribeAssetBundleImportJob operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAssetBundleImportJob
default CompletableFuture<DescribeAssetBundleImportJobResponse> describeAssetBundleImportJob(Consumer<DescribeAssetBundleImportJobRequest.Builder> describeAssetBundleImportJobRequest) Describes an existing import job.
Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.
This is a convenience which creates an instance of the
DescribeAssetBundleImportJobRequest.Builderavoiding the need to create one manually viaDescribeAssetBundleImportJobRequest.builder()- Parameters:
describeAssetBundleImportJobRequest- AConsumerthat will call methods onDescribeAssetBundleImportJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeAssetBundleImportJob operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeBrand
default CompletableFuture<DescribeBrandResponse> describeBrand(DescribeBrandRequest describeBrandRequest) Describes a brand.
- Parameters:
describeBrandRequest-- Returns:
- A Java Future containing the result of the DescribeBrand operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InternalServerException An internal service exception.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeBrand
default CompletableFuture<DescribeBrandResponse> describeBrand(Consumer<DescribeBrandRequest.Builder> describeBrandRequest) Describes a brand.
This is a convenience which creates an instance of the
DescribeBrandRequest.Builderavoiding the need to create one manually viaDescribeBrandRequest.builder()- Parameters:
describeBrandRequest- AConsumerthat will call methods onDescribeBrandRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeBrand operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InternalServerException An internal service exception.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeBrandAssignment
default CompletableFuture<DescribeBrandAssignmentResponse> describeBrandAssignment(DescribeBrandAssignmentRequest describeBrandAssignmentRequest) Describes a brand assignment.
- Parameters:
describeBrandAssignmentRequest-- Returns:
- A Java Future containing the result of the DescribeBrandAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InternalServerException An internal service exception.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeBrandAssignment
default CompletableFuture<DescribeBrandAssignmentResponse> describeBrandAssignment(Consumer<DescribeBrandAssignmentRequest.Builder> describeBrandAssignmentRequest) Describes a brand assignment.
This is a convenience which creates an instance of the
DescribeBrandAssignmentRequest.Builderavoiding the need to create one manually viaDescribeBrandAssignmentRequest.builder()- Parameters:
describeBrandAssignmentRequest- AConsumerthat will call methods onDescribeBrandAssignmentRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeBrandAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InternalServerException An internal service exception.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeBrandPublishedVersion
default CompletableFuture<DescribeBrandPublishedVersionResponse> describeBrandPublishedVersion(DescribeBrandPublishedVersionRequest describeBrandPublishedVersionRequest) Describes the published version of the brand.
- Parameters:
describeBrandPublishedVersionRequest-- Returns:
- A Java Future containing the result of the DescribeBrandPublishedVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InternalServerException An internal service exception.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeBrandPublishedVersion
default CompletableFuture<DescribeBrandPublishedVersionResponse> describeBrandPublishedVersion(Consumer<DescribeBrandPublishedVersionRequest.Builder> describeBrandPublishedVersionRequest) Describes the published version of the brand.
This is a convenience which creates an instance of the
DescribeBrandPublishedVersionRequest.Builderavoiding the need to create one manually viaDescribeBrandPublishedVersionRequest.builder()- Parameters:
describeBrandPublishedVersionRequest- AConsumerthat will call methods onDescribeBrandPublishedVersionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeBrandPublishedVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InternalServerException An internal service exception.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeCustomPermissions
default CompletableFuture<DescribeCustomPermissionsResponse> describeCustomPermissions(DescribeCustomPermissionsRequest describeCustomPermissionsRequest) Describes a custom permissions profile.
- Parameters:
describeCustomPermissionsRequest-- Returns:
- A Java Future containing the result of the DescribeCustomPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeCustomPermissions
default CompletableFuture<DescribeCustomPermissionsResponse> describeCustomPermissions(Consumer<DescribeCustomPermissionsRequest.Builder> describeCustomPermissionsRequest) Describes a custom permissions profile.
This is a convenience which creates an instance of the
DescribeCustomPermissionsRequest.Builderavoiding the need to create one manually viaDescribeCustomPermissionsRequest.builder()- Parameters:
describeCustomPermissionsRequest- AConsumerthat will call methods onDescribeCustomPermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeCustomPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDashboard
default CompletableFuture<DescribeDashboardResponse> describeDashboard(DescribeDashboardRequest describeDashboardRequest) Provides a summary for a dashboard.
- Parameters:
describeDashboardRequest-- Returns:
- A Java Future containing the result of the DescribeDashboard operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDashboard
default CompletableFuture<DescribeDashboardResponse> describeDashboard(Consumer<DescribeDashboardRequest.Builder> describeDashboardRequest) Provides a summary for a dashboard.
This is a convenience which creates an instance of the
DescribeDashboardRequest.Builderavoiding the need to create one manually viaDescribeDashboardRequest.builder()- Parameters:
describeDashboardRequest- AConsumerthat will call methods onDescribeDashboardRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeDashboard operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDashboardDefinition
default CompletableFuture<DescribeDashboardDefinitionResponse> describeDashboardDefinition(DescribeDashboardDefinitionRequest describeDashboardDefinitionRequest) Provides a detailed description of the definition of a dashboard.
If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the
DescribeDashboardinstead.- Parameters:
describeDashboardDefinitionRequest-- Returns:
- A Java Future containing the result of the DescribeDashboardDefinition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDashboardDefinition
default CompletableFuture<DescribeDashboardDefinitionResponse> describeDashboardDefinition(Consumer<DescribeDashboardDefinitionRequest.Builder> describeDashboardDefinitionRequest) Provides a detailed description of the definition of a dashboard.
If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the
DescribeDashboardinstead.
This is a convenience which creates an instance of the
DescribeDashboardDefinitionRequest.Builderavoiding the need to create one manually viaDescribeDashboardDefinitionRequest.builder()- Parameters:
describeDashboardDefinitionRequest- AConsumerthat will call methods onDescribeDashboardDefinitionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeDashboardDefinition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDashboardPermissions
default CompletableFuture<DescribeDashboardPermissionsResponse> describeDashboardPermissions(DescribeDashboardPermissionsRequest describeDashboardPermissionsRequest) Describes read and write permissions for a dashboard.
- Parameters:
describeDashboardPermissionsRequest-- Returns:
- A Java Future containing the result of the DescribeDashboardPermissions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDashboardPermissions
default CompletableFuture<DescribeDashboardPermissionsResponse> describeDashboardPermissions(Consumer<DescribeDashboardPermissionsRequest.Builder> describeDashboardPermissionsRequest) Describes read and write permissions for a dashboard.
This is a convenience which creates an instance of the
DescribeDashboardPermissionsRequest.Builderavoiding the need to create one manually viaDescribeDashboardPermissionsRequest.builder()- Parameters:
describeDashboardPermissionsRequest- AConsumerthat will call methods onDescribeDashboardPermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeDashboardPermissions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDashboardSnapshotJob
default CompletableFuture<DescribeDashboardSnapshotJobResponse> describeDashboardSnapshotJob(DescribeDashboardSnapshotJobRequest describeDashboardSnapshotJobRequest) Describes an existing snapshot job.
Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see
JobStatus.- Parameters:
describeDashboardSnapshotJobRequest-- Returns:
- A Java Future containing the result of the DescribeDashboardSnapshotJob operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDashboardSnapshotJob
default CompletableFuture<DescribeDashboardSnapshotJobResponse> describeDashboardSnapshotJob(Consumer<DescribeDashboardSnapshotJobRequest.Builder> describeDashboardSnapshotJobRequest) Describes an existing snapshot job.
Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see
JobStatus.
This is a convenience which creates an instance of the
DescribeDashboardSnapshotJobRequest.Builderavoiding the need to create one manually viaDescribeDashboardSnapshotJobRequest.builder()- Parameters:
describeDashboardSnapshotJobRequest- AConsumerthat will call methods onDescribeDashboardSnapshotJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeDashboardSnapshotJob operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDashboardSnapshotJobResult
default CompletableFuture<DescribeDashboardSnapshotJobResultResponse> describeDashboardSnapshotJobResult(DescribeDashboardSnapshotJobResultRequest describeDashboardSnapshotJobResultRequest) Describes the result of an existing snapshot job that has finished running.
A finished snapshot job will return a
COMPLETEDorFAILEDstatus when you poll the job with aDescribeDashboardSnapshotJobAPI call.If the job has not finished running, this operation returns a message that says
Dashboard Snapshot Job with id <SnapshotjobId> has not reached a terminal state..- Parameters:
describeDashboardSnapshotJobResultRequest-- Returns:
- A Java Future containing the result of the DescribeDashboardSnapshotJobResult operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDashboardSnapshotJobResult
default CompletableFuture<DescribeDashboardSnapshotJobResultResponse> describeDashboardSnapshotJobResult(Consumer<DescribeDashboardSnapshotJobResultRequest.Builder> describeDashboardSnapshotJobResultRequest) Describes the result of an existing snapshot job that has finished running.
A finished snapshot job will return a
COMPLETEDorFAILEDstatus when you poll the job with aDescribeDashboardSnapshotJobAPI call.If the job has not finished running, this operation returns a message that says
Dashboard Snapshot Job with id <SnapshotjobId> has not reached a terminal state..
This is a convenience which creates an instance of the
DescribeDashboardSnapshotJobResultRequest.Builderavoiding the need to create one manually viaDescribeDashboardSnapshotJobResultRequest.builder()- Parameters:
describeDashboardSnapshotJobResultRequest- AConsumerthat will call methods onDescribeDashboardSnapshotJobResultRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeDashboardSnapshotJobResult operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDashboardsQAConfiguration
default CompletableFuture<DescribeDashboardsQaConfigurationResponse> describeDashboardsQAConfiguration(DescribeDashboardsQaConfigurationRequest describeDashboardsQaConfigurationRequest) Describes an existing dashboard QA configuration.
- Parameters:
describeDashboardsQaConfigurationRequest-- Returns:
- A Java Future containing the result of the DescribeDashboardsQAConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDashboardsQAConfiguration
default CompletableFuture<DescribeDashboardsQaConfigurationResponse> describeDashboardsQAConfiguration(Consumer<DescribeDashboardsQaConfigurationRequest.Builder> describeDashboardsQaConfigurationRequest) Describes an existing dashboard QA configuration.
This is a convenience which creates an instance of the
DescribeDashboardsQaConfigurationRequest.Builderavoiding the need to create one manually viaDescribeDashboardsQaConfigurationRequest.builder()- Parameters:
describeDashboardsQaConfigurationRequest- AConsumerthat will call methods onDescribeDashboardsQaConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeDashboardsQAConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDataSet
default CompletableFuture<DescribeDataSetResponse> describeDataSet(DescribeDataSetRequest describeDataSetRequest) Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.
- Parameters:
describeDataSetRequest-- Returns:
- A Java Future containing the result of the DescribeDataSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDataSet
default CompletableFuture<DescribeDataSetResponse> describeDataSet(Consumer<DescribeDataSetRequest.Builder> describeDataSetRequest) Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.
This is a convenience which creates an instance of the
DescribeDataSetRequest.Builderavoiding the need to create one manually viaDescribeDataSetRequest.builder()- Parameters:
describeDataSetRequest- AConsumerthat will call methods onDescribeDataSetRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeDataSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDataSetPermissions
default CompletableFuture<DescribeDataSetPermissionsResponse> describeDataSetPermissions(DescribeDataSetPermissionsRequest describeDataSetPermissionsRequest) Describes the permissions on a dataset.
The permissions resource is
arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.- Parameters:
describeDataSetPermissionsRequest-- Returns:
- A Java Future containing the result of the DescribeDataSetPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDataSetPermissions
default CompletableFuture<DescribeDataSetPermissionsResponse> describeDataSetPermissions(Consumer<DescribeDataSetPermissionsRequest.Builder> describeDataSetPermissionsRequest) Describes the permissions on a dataset.
The permissions resource is
arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
This is a convenience which creates an instance of the
DescribeDataSetPermissionsRequest.Builderavoiding the need to create one manually viaDescribeDataSetPermissionsRequest.builder()- Parameters:
describeDataSetPermissionsRequest- AConsumerthat will call methods onDescribeDataSetPermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeDataSetPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDataSetRefreshProperties
default CompletableFuture<DescribeDataSetRefreshPropertiesResponse> describeDataSetRefreshProperties(DescribeDataSetRefreshPropertiesRequest describeDataSetRefreshPropertiesRequest) Describes the refresh properties of a dataset.
- Parameters:
describeDataSetRefreshPropertiesRequest-- Returns:
- A Java Future containing the result of the DescribeDataSetRefreshProperties operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDataSetRefreshProperties
default CompletableFuture<DescribeDataSetRefreshPropertiesResponse> describeDataSetRefreshProperties(Consumer<DescribeDataSetRefreshPropertiesRequest.Builder> describeDataSetRefreshPropertiesRequest) Describes the refresh properties of a dataset.
This is a convenience which creates an instance of the
DescribeDataSetRefreshPropertiesRequest.Builderavoiding the need to create one manually viaDescribeDataSetRefreshPropertiesRequest.builder()- Parameters:
describeDataSetRefreshPropertiesRequest- AConsumerthat will call methods onDescribeDataSetRefreshPropertiesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeDataSetRefreshProperties operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDataSource
default CompletableFuture<DescribeDataSourceResponse> describeDataSource(DescribeDataSourceRequest describeDataSourceRequest) Describes a data source.
- Parameters:
describeDataSourceRequest-- Returns:
- A Java Future containing the result of the DescribeDataSource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDataSource
default CompletableFuture<DescribeDataSourceResponse> describeDataSource(Consumer<DescribeDataSourceRequest.Builder> describeDataSourceRequest) Describes a data source.
This is a convenience which creates an instance of the
DescribeDataSourceRequest.Builderavoiding the need to create one manually viaDescribeDataSourceRequest.builder()- Parameters:
describeDataSourceRequest- AConsumerthat will call methods onDescribeDataSourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeDataSource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDataSourcePermissions
default CompletableFuture<DescribeDataSourcePermissionsResponse> describeDataSourcePermissions(DescribeDataSourcePermissionsRequest describeDataSourcePermissionsRequest) Describes the resource permissions for a data source.
- Parameters:
describeDataSourcePermissionsRequest-- Returns:
- A Java Future containing the result of the DescribeDataSourcePermissions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDataSourcePermissions
default CompletableFuture<DescribeDataSourcePermissionsResponse> describeDataSourcePermissions(Consumer<DescribeDataSourcePermissionsRequest.Builder> describeDataSourcePermissionsRequest) Describes the resource permissions for a data source.
This is a convenience which creates an instance of the
DescribeDataSourcePermissionsRequest.Builderavoiding the need to create one manually viaDescribeDataSourcePermissionsRequest.builder()- Parameters:
describeDataSourcePermissionsRequest- AConsumerthat will call methods onDescribeDataSourcePermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeDataSourcePermissions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDefaultQBusinessApplication
default CompletableFuture<DescribeDefaultQBusinessApplicationResponse> describeDefaultQBusinessApplication(DescribeDefaultQBusinessApplicationRequest describeDefaultQBusinessApplicationRequest) Describes a Amazon Q Business application that is linked to an Quick Sight account.
- Parameters:
describeDefaultQBusinessApplicationRequest-- Returns:
- A Java Future containing the result of the DescribeDefaultQBusinessApplication operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDefaultQBusinessApplication
default CompletableFuture<DescribeDefaultQBusinessApplicationResponse> describeDefaultQBusinessApplication(Consumer<DescribeDefaultQBusinessApplicationRequest.Builder> describeDefaultQBusinessApplicationRequest) Describes a Amazon Q Business application that is linked to an Quick Sight account.
This is a convenience which creates an instance of the
DescribeDefaultQBusinessApplicationRequest.Builderavoiding the need to create one manually viaDescribeDefaultQBusinessApplicationRequest.builder()- Parameters:
describeDefaultQBusinessApplicationRequest- AConsumerthat will call methods onDescribeDefaultQBusinessApplicationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeDefaultQBusinessApplication operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFolder
default CompletableFuture<DescribeFolderResponse> describeFolder(DescribeFolderRequest describeFolderRequest) Describes a folder.
- Parameters:
describeFolderRequest-- Returns:
- A Java Future containing the result of the DescribeFolder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFolder
default CompletableFuture<DescribeFolderResponse> describeFolder(Consumer<DescribeFolderRequest.Builder> describeFolderRequest) Describes a folder.
This is a convenience which creates an instance of the
DescribeFolderRequest.Builderavoiding the need to create one manually viaDescribeFolderRequest.builder()- Parameters:
describeFolderRequest- AConsumerthat will call methods onDescribeFolderRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeFolder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFolderPermissions
default CompletableFuture<DescribeFolderPermissionsResponse> describeFolderPermissions(DescribeFolderPermissionsRequest describeFolderPermissionsRequest) Describes permissions for a folder.
- Parameters:
describeFolderPermissionsRequest-- Returns:
- A Java Future containing the result of the DescribeFolderPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFolderPermissions
default CompletableFuture<DescribeFolderPermissionsResponse> describeFolderPermissions(Consumer<DescribeFolderPermissionsRequest.Builder> describeFolderPermissionsRequest) Describes permissions for a folder.
This is a convenience which creates an instance of the
DescribeFolderPermissionsRequest.Builderavoiding the need to create one manually viaDescribeFolderPermissionsRequest.builder()- Parameters:
describeFolderPermissionsRequest- AConsumerthat will call methods onDescribeFolderPermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeFolderPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFolderPermissionsPaginator
default DescribeFolderPermissionsPublisher describeFolderPermissionsPaginator(DescribeFolderPermissionsRequest describeFolderPermissionsRequest) This is a variant of
describeFolderPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.DescribeFolderPermissionsPublisher publisher = client.describeFolderPermissionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.DescribeFolderPermissionsPublisher publisher = client.describeFolderPermissionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFolderPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsRequest)operation.- Parameters:
describeFolderPermissionsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFolderPermissionsPaginator
default DescribeFolderPermissionsPublisher describeFolderPermissionsPaginator(Consumer<DescribeFolderPermissionsRequest.Builder> describeFolderPermissionsRequest) This is a variant of
describeFolderPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.DescribeFolderPermissionsPublisher publisher = client.describeFolderPermissionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.DescribeFolderPermissionsPublisher publisher = client.describeFolderPermissionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFolderPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsRequest)operation.
This is a convenience which creates an instance of the
DescribeFolderPermissionsRequest.Builderavoiding the need to create one manually viaDescribeFolderPermissionsRequest.builder()- Parameters:
describeFolderPermissionsRequest- AConsumerthat will call methods onDescribeFolderPermissionsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFolderResolvedPermissions
default CompletableFuture<DescribeFolderResolvedPermissionsResponse> describeFolderResolvedPermissions(DescribeFolderResolvedPermissionsRequest describeFolderResolvedPermissionsRequest) Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
- Parameters:
describeFolderResolvedPermissionsRequest-- Returns:
- A Java Future containing the result of the DescribeFolderResolvedPermissions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFolderResolvedPermissions
default CompletableFuture<DescribeFolderResolvedPermissionsResponse> describeFolderResolvedPermissions(Consumer<DescribeFolderResolvedPermissionsRequest.Builder> describeFolderResolvedPermissionsRequest) Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
This is a convenience which creates an instance of the
DescribeFolderResolvedPermissionsRequest.Builderavoiding the need to create one manually viaDescribeFolderResolvedPermissionsRequest.builder()- Parameters:
describeFolderResolvedPermissionsRequest- AConsumerthat will call methods onDescribeFolderResolvedPermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeFolderResolvedPermissions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFolderResolvedPermissionsPaginator
default DescribeFolderResolvedPermissionsPublisher describeFolderResolvedPermissionsPaginator(DescribeFolderResolvedPermissionsRequest describeFolderResolvedPermissionsRequest) This is a variant of
describeFolderResolvedPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.DescribeFolderResolvedPermissionsPublisher publisher = client.describeFolderResolvedPermissionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.DescribeFolderResolvedPermissionsPublisher publisher = client.describeFolderResolvedPermissionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFolderResolvedPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsRequest)operation.- Parameters:
describeFolderResolvedPermissionsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFolderResolvedPermissionsPaginator
default DescribeFolderResolvedPermissionsPublisher describeFolderResolvedPermissionsPaginator(Consumer<DescribeFolderResolvedPermissionsRequest.Builder> describeFolderResolvedPermissionsRequest) This is a variant of
describeFolderResolvedPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.DescribeFolderResolvedPermissionsPublisher publisher = client.describeFolderResolvedPermissionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.DescribeFolderResolvedPermissionsPublisher publisher = client.describeFolderResolvedPermissionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFolderResolvedPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsRequest)operation.
This is a convenience which creates an instance of the
DescribeFolderResolvedPermissionsRequest.Builderavoiding the need to create one manually viaDescribeFolderResolvedPermissionsRequest.builder()- Parameters:
describeFolderResolvedPermissionsRequest- AConsumerthat will call methods onDescribeFolderResolvedPermissionsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGroup
default CompletableFuture<DescribeGroupResponse> describeGroup(DescribeGroupRequest describeGroupRequest) Returns an Amazon Quick Sight group's description and Amazon Resource Name (ARN).
- Parameters:
describeGroupRequest-- Returns:
- A Java Future containing the result of the DescribeGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGroup
default CompletableFuture<DescribeGroupResponse> describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest) Returns an Amazon Quick Sight group's description and Amazon Resource Name (ARN).
This is a convenience which creates an instance of the
DescribeGroupRequest.Builderavoiding the need to create one manually viaDescribeGroupRequest.builder()- Parameters:
describeGroupRequest- AConsumerthat will call methods onDescribeGroupRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGroupMembership
default CompletableFuture<DescribeGroupMembershipResponse> describeGroupMembership(DescribeGroupMembershipRequest describeGroupMembershipRequest) Use the
DescribeGroupMembershipoperation 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 associatedGroupMemberobject is returned.- Parameters:
describeGroupMembershipRequest-- Returns:
- A Java Future containing the result of the DescribeGroupMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGroupMembership
default CompletableFuture<DescribeGroupMembershipResponse> describeGroupMembership(Consumer<DescribeGroupMembershipRequest.Builder> describeGroupMembershipRequest) Use the
DescribeGroupMembershipoperation 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 associatedGroupMemberobject is returned.
This is a convenience which creates an instance of the
DescribeGroupMembershipRequest.Builderavoiding the need to create one manually viaDescribeGroupMembershipRequest.builder()- Parameters:
describeGroupMembershipRequest- AConsumerthat will call methods onDescribeGroupMembershipRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeGroupMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeIAMPolicyAssignment
default CompletableFuture<DescribeIamPolicyAssignmentResponse> describeIAMPolicyAssignment(DescribeIamPolicyAssignmentRequest describeIamPolicyAssignmentRequest) Describes an existing IAM policy assignment, as specified by the assignment name.
- Parameters:
describeIamPolicyAssignmentRequest-- Returns:
- A Java Future containing the result of the DescribeIAMPolicyAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeIAMPolicyAssignment
default CompletableFuture<DescribeIamPolicyAssignmentResponse> describeIAMPolicyAssignment(Consumer<DescribeIamPolicyAssignmentRequest.Builder> describeIamPolicyAssignmentRequest) Describes an existing IAM policy assignment, as specified by the assignment name.
This is a convenience which creates an instance of the
DescribeIamPolicyAssignmentRequest.Builderavoiding the need to create one manually viaDescribeIamPolicyAssignmentRequest.builder()- Parameters:
describeIamPolicyAssignmentRequest- AConsumerthat will call methods onDescribeIamPolicyAssignmentRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeIAMPolicyAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeIngestion
default CompletableFuture<DescribeIngestionResponse> describeIngestion(DescribeIngestionRequest describeIngestionRequest) Describes a SPICE ingestion.
- Parameters:
describeIngestionRequest-- Returns:
- A Java Future containing the result of the DescribeIngestion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeIngestion
default CompletableFuture<DescribeIngestionResponse> describeIngestion(Consumer<DescribeIngestionRequest.Builder> describeIngestionRequest) Describes a SPICE ingestion.
This is a convenience which creates an instance of the
DescribeIngestionRequest.Builderavoiding the need to create one manually viaDescribeIngestionRequest.builder()- Parameters:
describeIngestionRequest- AConsumerthat will call methods onDescribeIngestionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeIngestion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeIpRestriction
default CompletableFuture<DescribeIpRestrictionResponse> describeIpRestriction(DescribeIpRestrictionRequest describeIpRestrictionRequest) Provides a summary and status of IP rules.
- Parameters:
describeIpRestrictionRequest-- Returns:
- A Java Future containing the result of the DescribeIpRestriction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeIpRestriction
default CompletableFuture<DescribeIpRestrictionResponse> describeIpRestriction(Consumer<DescribeIpRestrictionRequest.Builder> describeIpRestrictionRequest) Provides a summary and status of IP rules.
This is a convenience which creates an instance of the
DescribeIpRestrictionRequest.Builderavoiding the need to create one manually viaDescribeIpRestrictionRequest.builder()- Parameters:
describeIpRestrictionRequest- AConsumerthat will call methods onDescribeIpRestrictionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeIpRestriction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeKeyRegistration
default CompletableFuture<DescribeKeyRegistrationResponse> describeKeyRegistration(DescribeKeyRegistrationRequest describeKeyRegistrationRequest) Describes all customer managed key registrations in a Quick Sight account.
- Parameters:
describeKeyRegistrationRequest-- Returns:
- A Java Future containing the result of the DescribeKeyRegistration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeKeyRegistration
default CompletableFuture<DescribeKeyRegistrationResponse> describeKeyRegistration(Consumer<DescribeKeyRegistrationRequest.Builder> describeKeyRegistrationRequest) Describes all customer managed key registrations in a Quick Sight account.
This is a convenience which creates an instance of the
DescribeKeyRegistrationRequest.Builderavoiding the need to create one manually viaDescribeKeyRegistrationRequest.builder()- Parameters:
describeKeyRegistrationRequest- AConsumerthat will call methods onDescribeKeyRegistrationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeKeyRegistration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeNamespace
default CompletableFuture<DescribeNamespaceResponse> describeNamespace(DescribeNamespaceRequest describeNamespaceRequest) Describes the current namespace.
- Parameters:
describeNamespaceRequest-- Returns:
- A Java Future containing the result of the DescribeNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeNamespace
default CompletableFuture<DescribeNamespaceResponse> describeNamespace(Consumer<DescribeNamespaceRequest.Builder> describeNamespaceRequest) Describes the current namespace.
This is a convenience which creates an instance of the
DescribeNamespaceRequest.Builderavoiding the need to create one manually viaDescribeNamespaceRequest.builder()- Parameters:
describeNamespaceRequest- AConsumerthat will call methods onDescribeNamespaceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeQPersonalizationConfiguration
default CompletableFuture<DescribeQPersonalizationConfigurationResponse> describeQPersonalizationConfiguration(DescribeQPersonalizationConfigurationRequest describeQPersonalizationConfigurationRequest) Describes a personalization configuration.
- Parameters:
describeQPersonalizationConfigurationRequest-- Returns:
- A Java Future containing the result of the DescribeQPersonalizationConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeQPersonalizationConfiguration
default CompletableFuture<DescribeQPersonalizationConfigurationResponse> describeQPersonalizationConfiguration(Consumer<DescribeQPersonalizationConfigurationRequest.Builder> describeQPersonalizationConfigurationRequest) Describes a personalization configuration.
This is a convenience which creates an instance of the
DescribeQPersonalizationConfigurationRequest.Builderavoiding the need to create one manually viaDescribeQPersonalizationConfigurationRequest.builder()- Parameters:
describeQPersonalizationConfigurationRequest- AConsumerthat will call methods onDescribeQPersonalizationConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeQPersonalizationConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeQuickSightQSearchConfiguration
default CompletableFuture<DescribeQuickSightQSearchConfigurationResponse> describeQuickSightQSearchConfiguration(DescribeQuickSightQSearchConfigurationRequest describeQuickSightQSearchConfigurationRequest) Describes the state of a Quick Sight Q Search configuration.
- Parameters:
describeQuickSightQSearchConfigurationRequest-- Returns:
- A Java Future containing the result of the DescribeQuickSightQSearchConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeQuickSightQSearchConfiguration
default CompletableFuture<DescribeQuickSightQSearchConfigurationResponse> describeQuickSightQSearchConfiguration(Consumer<DescribeQuickSightQSearchConfigurationRequest.Builder> describeQuickSightQSearchConfigurationRequest) Describes the state of a Quick Sight Q Search configuration.
This is a convenience which creates an instance of the
DescribeQuickSightQSearchConfigurationRequest.Builderavoiding the need to create one manually viaDescribeQuickSightQSearchConfigurationRequest.builder()- Parameters:
describeQuickSightQSearchConfigurationRequest- AConsumerthat will call methods onDescribeQuickSightQSearchConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeQuickSightQSearchConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRefreshSchedule
default CompletableFuture<DescribeRefreshScheduleResponse> describeRefreshSchedule(DescribeRefreshScheduleRequest describeRefreshScheduleRequest) Provides a summary of a refresh schedule.
- Parameters:
describeRefreshScheduleRequest-- Returns:
- A Java Future containing the result of the DescribeRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRefreshSchedule
default CompletableFuture<DescribeRefreshScheduleResponse> describeRefreshSchedule(Consumer<DescribeRefreshScheduleRequest.Builder> describeRefreshScheduleRequest) Provides a summary of a refresh schedule.
This is a convenience which creates an instance of the
DescribeRefreshScheduleRequest.Builderavoiding the need to create one manually viaDescribeRefreshScheduleRequest.builder()- Parameters:
describeRefreshScheduleRequest- AConsumerthat will call methods onDescribeRefreshScheduleRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRoleCustomPermission
default CompletableFuture<DescribeRoleCustomPermissionResponse> describeRoleCustomPermission(DescribeRoleCustomPermissionRequest describeRoleCustomPermissionRequest) Describes all custom permissions that are mapped to a role.
- Parameters:
describeRoleCustomPermissionRequest-- Returns:
- A Java Future containing the result of the DescribeRoleCustomPermission operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRoleCustomPermission
default CompletableFuture<DescribeRoleCustomPermissionResponse> describeRoleCustomPermission(Consumer<DescribeRoleCustomPermissionRequest.Builder> describeRoleCustomPermissionRequest) Describes all custom permissions that are mapped to a role.
This is a convenience which creates an instance of the
DescribeRoleCustomPermissionRequest.Builderavoiding the need to create one manually viaDescribeRoleCustomPermissionRequest.builder()- Parameters:
describeRoleCustomPermissionRequest- AConsumerthat will call methods onDescribeRoleCustomPermissionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeRoleCustomPermission operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTemplate
default CompletableFuture<DescribeTemplateResponse> describeTemplate(DescribeTemplateRequest describeTemplateRequest) Describes a template's metadata.
- Parameters:
describeTemplateRequest-- Returns:
- A Java Future containing the result of the DescribeTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTemplate
default CompletableFuture<DescribeTemplateResponse> describeTemplate(Consumer<DescribeTemplateRequest.Builder> describeTemplateRequest) Describes a template's metadata.
This is a convenience which creates an instance of the
DescribeTemplateRequest.Builderavoiding the need to create one manually viaDescribeTemplateRequest.builder()- Parameters:
describeTemplateRequest- AConsumerthat will call methods onDescribeTemplateRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTemplateAlias
default CompletableFuture<DescribeTemplateAliasResponse> describeTemplateAlias(DescribeTemplateAliasRequest describeTemplateAliasRequest) Describes the template alias for a template.
- Parameters:
describeTemplateAliasRequest-- Returns:
- A Java Future containing the result of the DescribeTemplateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTemplateAlias
default CompletableFuture<DescribeTemplateAliasResponse> describeTemplateAlias(Consumer<DescribeTemplateAliasRequest.Builder> describeTemplateAliasRequest) Describes the template alias for a template.
This is a convenience which creates an instance of the
DescribeTemplateAliasRequest.Builderavoiding the need to create one manually viaDescribeTemplateAliasRequest.builder()- Parameters:
describeTemplateAliasRequest- AConsumerthat will call methods onDescribeTemplateAliasRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeTemplateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTemplateDefinition
default CompletableFuture<DescribeTemplateDefinitionResponse> describeTemplateDefinition(DescribeTemplateDefinitionRequest describeTemplateDefinitionRequest) Provides a detailed description of the definition of a template.
If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the
DescribeTemplateinstead.- Parameters:
describeTemplateDefinitionRequest-- Returns:
- A Java Future containing the result of the DescribeTemplateDefinition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTemplateDefinition
default CompletableFuture<DescribeTemplateDefinitionResponse> describeTemplateDefinition(Consumer<DescribeTemplateDefinitionRequest.Builder> describeTemplateDefinitionRequest) Provides a detailed description of the definition of a template.
If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the
DescribeTemplateinstead.
This is a convenience which creates an instance of the
DescribeTemplateDefinitionRequest.Builderavoiding the need to create one manually viaDescribeTemplateDefinitionRequest.builder()- Parameters:
describeTemplateDefinitionRequest- AConsumerthat will call methods onDescribeTemplateDefinitionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeTemplateDefinition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTemplatePermissions
default CompletableFuture<DescribeTemplatePermissionsResponse> describeTemplatePermissions(DescribeTemplatePermissionsRequest describeTemplatePermissionsRequest) Describes read and write permissions on a template.
- Parameters:
describeTemplatePermissionsRequest-- Returns:
- A Java Future containing the result of the DescribeTemplatePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTemplatePermissions
default CompletableFuture<DescribeTemplatePermissionsResponse> describeTemplatePermissions(Consumer<DescribeTemplatePermissionsRequest.Builder> describeTemplatePermissionsRequest) Describes read and write permissions on a template.
This is a convenience which creates an instance of the
DescribeTemplatePermissionsRequest.Builderavoiding the need to create one manually viaDescribeTemplatePermissionsRequest.builder()- Parameters:
describeTemplatePermissionsRequest- AConsumerthat will call methods onDescribeTemplatePermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeTemplatePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTheme
default CompletableFuture<DescribeThemeResponse> describeTheme(DescribeThemeRequest describeThemeRequest) Describes a theme.
- Parameters:
describeThemeRequest-- Returns:
- A Java Future containing the result of the DescribeTheme operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTheme
default CompletableFuture<DescribeThemeResponse> describeTheme(Consumer<DescribeThemeRequest.Builder> describeThemeRequest) Describes a theme.
This is a convenience which creates an instance of the
DescribeThemeRequest.Builderavoiding the need to create one manually viaDescribeThemeRequest.builder()- Parameters:
describeThemeRequest- AConsumerthat will call methods onDescribeThemeRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeTheme operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeThemeAlias
default CompletableFuture<DescribeThemeAliasResponse> describeThemeAlias(DescribeThemeAliasRequest describeThemeAliasRequest) Describes the alias for a theme.
- Parameters:
describeThemeAliasRequest-- Returns:
- A Java Future containing the result of the DescribeThemeAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeThemeAlias
default CompletableFuture<DescribeThemeAliasResponse> describeThemeAlias(Consumer<DescribeThemeAliasRequest.Builder> describeThemeAliasRequest) Describes the alias for a theme.
This is a convenience which creates an instance of the
DescribeThemeAliasRequest.Builderavoiding the need to create one manually viaDescribeThemeAliasRequest.builder()- Parameters:
describeThemeAliasRequest- AConsumerthat will call methods onDescribeThemeAliasRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeThemeAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeThemePermissions
default CompletableFuture<DescribeThemePermissionsResponse> describeThemePermissions(DescribeThemePermissionsRequest describeThemePermissionsRequest) Describes the read and write permissions for a theme.
- Parameters:
describeThemePermissionsRequest-- Returns:
- A Java Future containing the result of the DescribeThemePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeThemePermissions
default CompletableFuture<DescribeThemePermissionsResponse> describeThemePermissions(Consumer<DescribeThemePermissionsRequest.Builder> describeThemePermissionsRequest) Describes the read and write permissions for a theme.
This is a convenience which creates an instance of the
DescribeThemePermissionsRequest.Builderavoiding the need to create one manually viaDescribeThemePermissionsRequest.builder()- Parameters:
describeThemePermissionsRequest- AConsumerthat will call methods onDescribeThemePermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeThemePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTopic
default CompletableFuture<DescribeTopicResponse> describeTopic(DescribeTopicRequest describeTopicRequest) Describes a topic.
- Parameters:
describeTopicRequest-- Returns:
- A Java Future containing the result of the DescribeTopic operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTopic
default CompletableFuture<DescribeTopicResponse> describeTopic(Consumer<DescribeTopicRequest.Builder> describeTopicRequest) Describes a topic.
This is a convenience which creates an instance of the
DescribeTopicRequest.Builderavoiding the need to create one manually viaDescribeTopicRequest.builder()- Parameters:
describeTopicRequest- AConsumerthat will call methods onDescribeTopicRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeTopic operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTopicPermissions
default CompletableFuture<DescribeTopicPermissionsResponse> describeTopicPermissions(DescribeTopicPermissionsRequest describeTopicPermissionsRequest) Describes the permissions of a topic.
- Parameters:
describeTopicPermissionsRequest-- Returns:
- A Java Future containing the result of the DescribeTopicPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTopicPermissions
default CompletableFuture<DescribeTopicPermissionsResponse> describeTopicPermissions(Consumer<DescribeTopicPermissionsRequest.Builder> describeTopicPermissionsRequest) Describes the permissions of a topic.
This is a convenience which creates an instance of the
DescribeTopicPermissionsRequest.Builderavoiding the need to create one manually viaDescribeTopicPermissionsRequest.builder()- Parameters:
describeTopicPermissionsRequest- AConsumerthat will call methods onDescribeTopicPermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeTopicPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTopicRefresh
default CompletableFuture<DescribeTopicRefreshResponse> describeTopicRefresh(DescribeTopicRefreshRequest describeTopicRefreshRequest) Describes the status of a topic refresh.
- Parameters:
describeTopicRefreshRequest-- Returns:
- A Java Future containing the result of the DescribeTopicRefresh operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTopicRefresh
default CompletableFuture<DescribeTopicRefreshResponse> describeTopicRefresh(Consumer<DescribeTopicRefreshRequest.Builder> describeTopicRefreshRequest) Describes the status of a topic refresh.
This is a convenience which creates an instance of the
DescribeTopicRefreshRequest.Builderavoiding the need to create one manually viaDescribeTopicRefreshRequest.builder()- Parameters:
describeTopicRefreshRequest- AConsumerthat will call methods onDescribeTopicRefreshRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeTopicRefresh operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTopicRefreshSchedule
default CompletableFuture<DescribeTopicRefreshScheduleResponse> describeTopicRefreshSchedule(DescribeTopicRefreshScheduleRequest describeTopicRefreshScheduleRequest) Deletes a topic refresh schedule.
- Parameters:
describeTopicRefreshScheduleRequest-- Returns:
- A Java Future containing the result of the DescribeTopicRefreshSchedule operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeTopicRefreshSchedule
default CompletableFuture<DescribeTopicRefreshScheduleResponse> describeTopicRefreshSchedule(Consumer<DescribeTopicRefreshScheduleRequest.Builder> describeTopicRefreshScheduleRequest) Deletes a topic refresh schedule.
This is a convenience which creates an instance of the
DescribeTopicRefreshScheduleRequest.Builderavoiding the need to create one manually viaDescribeTopicRefreshScheduleRequest.builder()- Parameters:
describeTopicRefreshScheduleRequest- AConsumerthat will call methods onDescribeTopicRefreshScheduleRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeTopicRefreshSchedule operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeUser
default CompletableFuture<DescribeUserResponse> describeUser(DescribeUserRequest describeUserRequest) Returns information about a user, given the user name.
- Parameters:
describeUserRequest-- Returns:
- A Java Future containing the result of the DescribeUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeUser
default CompletableFuture<DescribeUserResponse> describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest) Returns information about a user, given the user name.
This is a convenience which creates an instance of the
DescribeUserRequest.Builderavoiding the need to create one manually viaDescribeUserRequest.builder()- Parameters:
describeUserRequest- AConsumerthat will call methods onDescribeUserRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeVPCConnection
default CompletableFuture<DescribeVpcConnectionResponse> describeVPCConnection(DescribeVpcConnectionRequest describeVpcConnectionRequest) Describes a VPC connection.
- Parameters:
describeVpcConnectionRequest-- Returns:
- A Java Future containing the result of the DescribeVPCConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeVPCConnection
default CompletableFuture<DescribeVpcConnectionResponse> describeVPCConnection(Consumer<DescribeVpcConnectionRequest.Builder> describeVpcConnectionRequest) Describes a VPC connection.
This is a convenience which creates an instance of the
DescribeVpcConnectionRequest.Builderavoiding the need to create one manually viaDescribeVpcConnectionRequest.builder()- Parameters:
describeVpcConnectionRequest- AConsumerthat will call methods onDescribeVpcConnectionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeVPCConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
generateEmbedUrlForAnonymousUser
default CompletableFuture<GenerateEmbedUrlForAnonymousUserResponse> generateEmbedUrlForAnonymousUser(GenerateEmbedUrlForAnonymousUserRequest generateEmbedUrlForAnonymousUserRequest) Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.
The following rules apply to the generated URL:
-
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
-
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutesparameter. 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.
- Parameters:
generateEmbedUrlForAnonymousUserRequest-- Returns:
- A Java Future containing the result of the GenerateEmbedUrlForAnonymousUser operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- SessionLifetimeInMinutesInvalidException The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be 15-600 minutes.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- UnsupportedPricingPlanException This error indicates that you are calling an embedding operation in
Amazon Quick Sight without the required pricing plan on your Amazon Web Services account. Before you can
use embedding for anonymous users, a Quick Suite administrator needs to add capacity pricing to Quick
Sight. You can do this on the Manage Quick Suite page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrlAPI operation with the--identity-type ANONYMOUSoption. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
generateEmbedUrlForAnonymousUser
default CompletableFuture<GenerateEmbedUrlForAnonymousUserResponse> generateEmbedUrlForAnonymousUser(Consumer<GenerateEmbedUrlForAnonymousUserRequest.Builder> generateEmbedUrlForAnonymousUserRequest) Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.
The following rules apply to the generated URL:
-
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
-
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutesparameter. 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.
This is a convenience which creates an instance of the
GenerateEmbedUrlForAnonymousUserRequest.Builderavoiding the need to create one manually viaGenerateEmbedUrlForAnonymousUserRequest.builder()- Parameters:
generateEmbedUrlForAnonymousUserRequest- AConsumerthat will call methods onGenerateEmbedUrlForAnonymousUserRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GenerateEmbedUrlForAnonymousUser operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- SessionLifetimeInMinutesInvalidException The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be 15-600 minutes.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- UnsupportedPricingPlanException This error indicates that you are calling an embedding operation in
Amazon Quick Sight without the required pricing plan on your Amazon Web Services account. Before you can
use embedding for anonymous users, a Quick Suite administrator needs to add capacity pricing to Quick
Sight. You can do this on the Manage Quick Suite page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrlAPI operation with the--identity-type ANONYMOUSoption. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
generateEmbedUrlForRegisteredUser
default CompletableFuture<GenerateEmbedUrlForRegisteredUserResponse> generateEmbedUrlForRegisteredUser(GenerateEmbedUrlForRegisteredUserRequest generateEmbedUrlForRegisteredUserRequest) Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.
The following rules apply to the generated URL:
-
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
-
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutesparameter.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.
- Parameters:
generateEmbedUrlForRegisteredUserRequest-- Returns:
- A Java Future containing the result of the GenerateEmbedUrlForRegisteredUser operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- QuickSightUserNotFoundException The user with the provided name isn't found. This error can happen in
any operation that requires finding a user based on a provided user name, such as
DeleteUser,DescribeUser, and so on. - ResourceNotFoundException One or more resources can't be found.
- SessionLifetimeInMinutesInvalidException The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be 15-600 minutes.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- UnsupportedPricingPlanException This error indicates that you are calling an embedding operation in
Amazon Quick Sight without the required pricing plan on your Amazon Web Services account. Before you can
use embedding for anonymous users, a Quick Suite administrator needs to add capacity pricing to Quick
Sight. You can do this on the Manage Quick Suite page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrlAPI operation with the--identity-type ANONYMOUSoption. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
generateEmbedUrlForRegisteredUser
default CompletableFuture<GenerateEmbedUrlForRegisteredUserResponse> generateEmbedUrlForRegisteredUser(Consumer<GenerateEmbedUrlForRegisteredUserRequest.Builder> generateEmbedUrlForRegisteredUserRequest) Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.
The following rules apply to the generated URL:
-
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
-
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutesparameter.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.
This is a convenience which creates an instance of the
GenerateEmbedUrlForRegisteredUserRequest.Builderavoiding the need to create one manually viaGenerateEmbedUrlForRegisteredUserRequest.builder()- Parameters:
generateEmbedUrlForRegisteredUserRequest- AConsumerthat will call methods onGenerateEmbedUrlForRegisteredUserRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GenerateEmbedUrlForRegisteredUser operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- QuickSightUserNotFoundException The user with the provided name isn't found. This error can happen in
any operation that requires finding a user based on a provided user name, such as
DeleteUser,DescribeUser, and so on. - ResourceNotFoundException One or more resources can't be found.
- SessionLifetimeInMinutesInvalidException The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be 15-600 minutes.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- UnsupportedPricingPlanException This error indicates that you are calling an embedding operation in
Amazon Quick Sight without the required pricing plan on your Amazon Web Services account. Before you can
use embedding for anonymous users, a Quick Suite administrator needs to add capacity pricing to Quick
Sight. You can do this on the Manage Quick Suite page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrlAPI operation with the--identity-type ANONYMOUSoption. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
generateEmbedUrlForRegisteredUserWithIdentity
default CompletableFuture<GenerateEmbedUrlForRegisteredUserWithIdentityResponse> generateEmbedUrlForRegisteredUserWithIdentity(GenerateEmbedUrlForRegisteredUserWithIdentityRequest generateEmbedUrlForRegisteredUserWithIdentityRequest) Generates an embed URL that you can use to embed an Amazon Quick Sight experience in your website. This action can be used for any type of user that is registered in an Amazon Quick Sight account that uses IAM Identity Center for authentication. This API requires identity-enhanced IAM Role sessions for the authenticated user that the API call is being made for.
This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for Amazon Quick Sight with the scope value set to
quicksight:read. Before you use this action, make sure that you have configured the relevant Amazon Quick Sight resource and permissions.- Parameters:
generateEmbedUrlForRegisteredUserWithIdentityRequest-- Returns:
- A Java Future containing the result of the GenerateEmbedUrlForRegisteredUserWithIdentity operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- QuickSightUserNotFoundException The user with the provided name isn't found. This error can happen in
any operation that requires finding a user based on a provided user name, such as
DeleteUser,DescribeUser, and so on. - ResourceNotFoundException One or more resources can't be found.
- SessionLifetimeInMinutesInvalidException The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be 15-600 minutes.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- UnsupportedPricingPlanException This error indicates that you are calling an embedding operation in
Amazon Quick Sight without the required pricing plan on your Amazon Web Services account. Before you can
use embedding for anonymous users, a Quick Suite administrator needs to add capacity pricing to Quick
Sight. You can do this on the Manage Quick Suite page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrlAPI operation with the--identity-type ANONYMOUSoption. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
generateEmbedUrlForRegisteredUserWithIdentity
default CompletableFuture<GenerateEmbedUrlForRegisteredUserWithIdentityResponse> generateEmbedUrlForRegisteredUserWithIdentity(Consumer<GenerateEmbedUrlForRegisteredUserWithIdentityRequest.Builder> generateEmbedUrlForRegisteredUserWithIdentityRequest) Generates an embed URL that you can use to embed an Amazon Quick Sight experience in your website. This action can be used for any type of user that is registered in an Amazon Quick Sight account that uses IAM Identity Center for authentication. This API requires identity-enhanced IAM Role sessions for the authenticated user that the API call is being made for.
This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for Amazon Quick Sight with the scope value set to
quicksight:read. Before you use this action, make sure that you have configured the relevant Amazon Quick Sight resource and permissions.
This is a convenience which creates an instance of the
GenerateEmbedUrlForRegisteredUserWithIdentityRequest.Builderavoiding the need to create one manually viaGenerateEmbedUrlForRegisteredUserWithIdentityRequest.builder()- Parameters:
generateEmbedUrlForRegisteredUserWithIdentityRequest- AConsumerthat will call methods onGenerateEmbedUrlForRegisteredUserWithIdentityRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GenerateEmbedUrlForRegisteredUserWithIdentity operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- QuickSightUserNotFoundException The user with the provided name isn't found. This error can happen in
any operation that requires finding a user based on a provided user name, such as
DeleteUser,DescribeUser, and so on. - ResourceNotFoundException One or more resources can't be found.
- SessionLifetimeInMinutesInvalidException The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be 15-600 minutes.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- UnsupportedPricingPlanException This error indicates that you are calling an embedding operation in
Amazon Quick Sight without the required pricing plan on your Amazon Web Services account. Before you can
use embedding for anonymous users, a Quick Suite administrator needs to add capacity pricing to Quick
Sight. You can do this on the Manage Quick Suite page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrlAPI operation with the--identity-type ANONYMOUSoption. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDashboardEmbedUrl
default CompletableFuture<GetDashboardEmbedUrlResponse> getDashboardEmbedUrl(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest) Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon Quick Sight 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
GetDashboardEmbedURLonly 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 QuickSight.
-
The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional
SessionLifetimeInMinutesparameter 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.
- Parameters:
getDashboardEmbedUrlRequest-- Returns:
- A Java Future containing the result of the GetDashboardEmbedUrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- DomainNotWhitelistedException The domain specified isn't on the allow list. All domains for embedded dashboards must be added to the approved list by an Amazon Quick Suite admin.
- QuickSightUserNotFoundException The user with the provided name isn't found. This error can happen in
any operation that requires finding a user based on a provided user name, such as
DeleteUser,DescribeUser, and so on. - IdentityTypeNotSupportedException The identity type specified isn't supported. Supported identity
types include
IAMandQUICKSIGHT. - SessionLifetimeInMinutesInvalidException The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be 15-600 minutes.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- UnsupportedPricingPlanException This error indicates that you are calling an embedding operation in
Amazon Quick Sight without the required pricing plan on your Amazon Web Services account. Before you can
use embedding for anonymous users, a Quick Suite administrator needs to add capacity pricing to Quick
Sight. You can do this on the Manage Quick Suite page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrlAPI operation with the--identity-type ANONYMOUSoption. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getDashboardEmbedUrl
default CompletableFuture<GetDashboardEmbedUrlResponse> getDashboardEmbedUrl(Consumer<GetDashboardEmbedUrlRequest.Builder> getDashboardEmbedUrlRequest) Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon Quick Sight 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
GetDashboardEmbedURLonly 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 QuickSight.
-
The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional
SessionLifetimeInMinutesparameter 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.
This is a convenience which creates an instance of the
GetDashboardEmbedUrlRequest.Builderavoiding the need to create one manually viaGetDashboardEmbedUrlRequest.builder()- Parameters:
getDashboardEmbedUrlRequest- AConsumerthat will call methods onGetDashboardEmbedUrlRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetDashboardEmbedUrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- DomainNotWhitelistedException The domain specified isn't on the allow list. All domains for embedded dashboards must be added to the approved list by an Amazon Quick Suite admin.
- QuickSightUserNotFoundException The user with the provided name isn't found. This error can happen in
any operation that requires finding a user based on a provided user name, such as
DeleteUser,DescribeUser, and so on. - IdentityTypeNotSupportedException The identity type specified isn't supported. Supported identity
types include
IAMandQUICKSIGHT. - SessionLifetimeInMinutesInvalidException The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be 15-600 minutes.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- UnsupportedPricingPlanException This error indicates that you are calling an embedding operation in
Amazon Quick Sight without the required pricing plan on your Amazon Web Services account. Before you can
use embedding for anonymous users, a Quick Suite administrator needs to add capacity pricing to Quick
Sight. You can do this on the Manage Quick Suite page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrlAPI operation with the--identity-type ANONYMOUSoption. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getFlowMetadata
default CompletableFuture<GetFlowMetadataResponse> getFlowMetadata(GetFlowMetadataRequest getFlowMetadataRequest) Retrieves the metadata of a flow, not including its definition specifying the steps.
- Parameters:
getFlowMetadataRequest-- Returns:
- A Java Future containing the result of the GetFlowMetadata operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getFlowMetadata
default CompletableFuture<GetFlowMetadataResponse> getFlowMetadata(Consumer<GetFlowMetadataRequest.Builder> getFlowMetadataRequest) Retrieves the metadata of a flow, not including its definition specifying the steps.
This is a convenience which creates an instance of the
GetFlowMetadataRequest.Builderavoiding the need to create one manually viaGetFlowMetadataRequest.builder()- Parameters:
getFlowMetadataRequest- AConsumerthat will call methods onGetFlowMetadataRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetFlowMetadata operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getFlowPermissions
default CompletableFuture<GetFlowPermissionsResponse> getFlowPermissions(GetFlowPermissionsRequest getFlowPermissionsRequest) Get permissions for a flow.
- Parameters:
getFlowPermissionsRequest-- Returns:
- A Java Future containing the result of the GetFlowPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getFlowPermissions
default CompletableFuture<GetFlowPermissionsResponse> getFlowPermissions(Consumer<GetFlowPermissionsRequest.Builder> getFlowPermissionsRequest) Get permissions for a flow.
This is a convenience which creates an instance of the
GetFlowPermissionsRequest.Builderavoiding the need to create one manually viaGetFlowPermissionsRequest.builder()- Parameters:
getFlowPermissionsRequest- AConsumerthat will call methods onGetFlowPermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetFlowPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSessionEmbedUrl
default CompletableFuture<GetSessionEmbedUrlResponse> getSessionEmbedUrl(GetSessionEmbedUrlRequest getSessionEmbedUrlRequest) Generates a session URL and authorization code that you can use to embed the Amazon Amazon Quick Sight console in your web server code. Use
GetSessionEmbedUrlwhere 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 Quick Sight 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 theUpdateUserAPI operation. UseRegisterUserAPI 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:- Parameters:
getSessionEmbedUrlRequest-- Returns:
- A Java Future containing the result of the GetSessionEmbedUrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- QuickSightUserNotFoundException The user with the provided name isn't found. This error can happen in
any operation that requires finding a user based on a provided user name, such as
DeleteUser,DescribeUser, and so on. - SessionLifetimeInMinutesInvalidException The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be 15-600 minutes.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSessionEmbedUrl
default CompletableFuture<GetSessionEmbedUrlResponse> getSessionEmbedUrl(Consumer<GetSessionEmbedUrlRequest.Builder> getSessionEmbedUrlRequest) Generates a session URL and authorization code that you can use to embed the Amazon Amazon Quick Sight console in your web server code. Use
GetSessionEmbedUrlwhere 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 Quick Sight 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 theUpdateUserAPI operation. UseRegisterUserAPI 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:
This is a convenience which creates an instance of the
GetSessionEmbedUrlRequest.Builderavoiding the need to create one manually viaGetSessionEmbedUrlRequest.builder()- Parameters:
getSessionEmbedUrlRequest- AConsumerthat will call methods onGetSessionEmbedUrlRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetSessionEmbedUrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- QuickSightUserNotFoundException The user with the provided name isn't found. This error can happen in
any operation that requires finding a user based on a provided user name, such as
DeleteUser,DescribeUser, and so on. - SessionLifetimeInMinutesInvalidException The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be 15-600 minutes.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listActionConnectors
default CompletableFuture<ListActionConnectorsResponse> listActionConnectors(ListActionConnectorsRequest listActionConnectorsRequest) Lists all action connectors in the specified Amazon Web Services account. Returns summary information for each connector including its name, type, creation time, and status.
- Parameters:
listActionConnectorsRequest-- Returns:
- A Java Future containing the result of the ListActionConnectors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listActionConnectors
default CompletableFuture<ListActionConnectorsResponse> listActionConnectors(Consumer<ListActionConnectorsRequest.Builder> listActionConnectorsRequest) Lists all action connectors in the specified Amazon Web Services account. Returns summary information for each connector including its name, type, creation time, and status.
This is a convenience which creates an instance of the
ListActionConnectorsRequest.Builderavoiding the need to create one manually viaListActionConnectorsRequest.builder()- Parameters:
listActionConnectorsRequest- AConsumerthat will call methods onListActionConnectorsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListActionConnectors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listActionConnectorsPaginator
default ListActionConnectorsPublisher listActionConnectorsPaginator(ListActionConnectorsRequest listActionConnectorsRequest) This is a variant of
listActionConnectors(software.amazon.awssdk.services.quicksight.model.ListActionConnectorsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListActionConnectorsPublisher publisher = client.listActionConnectorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListActionConnectorsPublisher publisher = client.listActionConnectorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListActionConnectorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListActionConnectorsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActionConnectors(software.amazon.awssdk.services.quicksight.model.ListActionConnectorsRequest)operation.- Parameters:
listActionConnectorsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listActionConnectorsPaginator
default ListActionConnectorsPublisher listActionConnectorsPaginator(Consumer<ListActionConnectorsRequest.Builder> listActionConnectorsRequest) This is a variant of
listActionConnectors(software.amazon.awssdk.services.quicksight.model.ListActionConnectorsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListActionConnectorsPublisher publisher = client.listActionConnectorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListActionConnectorsPublisher publisher = client.listActionConnectorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListActionConnectorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListActionConnectorsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActionConnectors(software.amazon.awssdk.services.quicksight.model.ListActionConnectorsRequest)operation.
This is a convenience which creates an instance of the
ListActionConnectorsRequest.Builderavoiding the need to create one manually viaListActionConnectorsRequest.builder()- Parameters:
listActionConnectorsRequest- AConsumerthat will call methods onListActionConnectorsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnalyses
default CompletableFuture<ListAnalysesResponse> listAnalyses(ListAnalysesRequest listAnalysesRequest) Lists Amazon Quick Sight analyses that exist in the specified Amazon Web Services account.
- Parameters:
listAnalysesRequest-- Returns:
- A Java Future containing the result of the ListAnalyses operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnalyses
default CompletableFuture<ListAnalysesResponse> listAnalyses(Consumer<ListAnalysesRequest.Builder> listAnalysesRequest) Lists Amazon Quick Sight analyses that exist in the specified Amazon Web Services account.
This is a convenience which creates an instance of the
ListAnalysesRequest.Builderavoiding the need to create one manually viaListAnalysesRequest.builder()- Parameters:
listAnalysesRequest- AConsumerthat will call methods onListAnalysesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListAnalyses operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnalysesPaginator
This is a variant of
listAnalyses(software.amazon.awssdk.services.quicksight.model.ListAnalysesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListAnalysesPublisher publisher = client.listAnalysesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListAnalysesPublisher publisher = client.listAnalysesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListAnalysesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListAnalysesResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAnalyses(software.amazon.awssdk.services.quicksight.model.ListAnalysesRequest)operation.- Parameters:
listAnalysesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAnalysesPaginator
default ListAnalysesPublisher listAnalysesPaginator(Consumer<ListAnalysesRequest.Builder> listAnalysesRequest) This is a variant of
listAnalyses(software.amazon.awssdk.services.quicksight.model.ListAnalysesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListAnalysesPublisher publisher = client.listAnalysesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListAnalysesPublisher publisher = client.listAnalysesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListAnalysesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListAnalysesResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAnalyses(software.amazon.awssdk.services.quicksight.model.ListAnalysesRequest)operation.
This is a convenience which creates an instance of the
ListAnalysesRequest.Builderavoiding the need to create one manually viaListAnalysesRequest.builder()- Parameters:
listAnalysesRequest- AConsumerthat will call methods onListAnalysesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssetBundleExportJobs
default CompletableFuture<ListAssetBundleExportJobsResponse> listAssetBundleExportJobs(ListAssetBundleExportJobsRequest listAssetBundleExportJobsRequest) Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs,
ListAssetBundleExportJobsonly returns the most recent job that uses the repeated job ID.- Parameters:
listAssetBundleExportJobsRequest-- Returns:
- A Java Future containing the result of the ListAssetBundleExportJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssetBundleExportJobs
default CompletableFuture<ListAssetBundleExportJobsResponse> listAssetBundleExportJobs(Consumer<ListAssetBundleExportJobsRequest.Builder> listAssetBundleExportJobsRequest) Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs,
ListAssetBundleExportJobsonly returns the most recent job that uses the repeated job ID.
This is a convenience which creates an instance of the
ListAssetBundleExportJobsRequest.Builderavoiding the need to create one manually viaListAssetBundleExportJobsRequest.builder()- Parameters:
listAssetBundleExportJobsRequest- AConsumerthat will call methods onListAssetBundleExportJobsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListAssetBundleExportJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssetBundleExportJobsPaginator
default ListAssetBundleExportJobsPublisher listAssetBundleExportJobsPaginator(ListAssetBundleExportJobsRequest listAssetBundleExportJobsRequest) This is a variant of
listAssetBundleExportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListAssetBundleExportJobsPublisher publisher = client.listAssetBundleExportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListAssetBundleExportJobsPublisher publisher = client.listAssetBundleExportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssetBundleExportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsRequest)operation.- Parameters:
listAssetBundleExportJobsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssetBundleExportJobsPaginator
default ListAssetBundleExportJobsPublisher listAssetBundleExportJobsPaginator(Consumer<ListAssetBundleExportJobsRequest.Builder> listAssetBundleExportJobsRequest) This is a variant of
listAssetBundleExportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListAssetBundleExportJobsPublisher publisher = client.listAssetBundleExportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListAssetBundleExportJobsPublisher publisher = client.listAssetBundleExportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssetBundleExportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsRequest)operation.
This is a convenience which creates an instance of the
ListAssetBundleExportJobsRequest.Builderavoiding the need to create one manually viaListAssetBundleExportJobsRequest.builder()- Parameters:
listAssetBundleExportJobsRequest- AConsumerthat will call methods onListAssetBundleExportJobsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssetBundleImportJobs
default CompletableFuture<ListAssetBundleImportJobsResponse> listAssetBundleImportJobs(ListAssetBundleImportJobsRequest listAssetBundleImportJobsRequest) Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs,
ListAssetBundleImportJobsonly returns the most recent job that uses the repeated job ID.- Parameters:
listAssetBundleImportJobsRequest-- Returns:
- A Java Future containing the result of the ListAssetBundleImportJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssetBundleImportJobs
default CompletableFuture<ListAssetBundleImportJobsResponse> listAssetBundleImportJobs(Consumer<ListAssetBundleImportJobsRequest.Builder> listAssetBundleImportJobsRequest) Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs,
ListAssetBundleImportJobsonly returns the most recent job that uses the repeated job ID.
This is a convenience which creates an instance of the
ListAssetBundleImportJobsRequest.Builderavoiding the need to create one manually viaListAssetBundleImportJobsRequest.builder()- Parameters:
listAssetBundleImportJobsRequest- AConsumerthat will call methods onListAssetBundleImportJobsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListAssetBundleImportJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssetBundleImportJobsPaginator
default ListAssetBundleImportJobsPublisher listAssetBundleImportJobsPaginator(ListAssetBundleImportJobsRequest listAssetBundleImportJobsRequest) This is a variant of
listAssetBundleImportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListAssetBundleImportJobsPublisher publisher = client.listAssetBundleImportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListAssetBundleImportJobsPublisher publisher = client.listAssetBundleImportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssetBundleImportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsRequest)operation.- Parameters:
listAssetBundleImportJobsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssetBundleImportJobsPaginator
default ListAssetBundleImportJobsPublisher listAssetBundleImportJobsPaginator(Consumer<ListAssetBundleImportJobsRequest.Builder> listAssetBundleImportJobsRequest) This is a variant of
listAssetBundleImportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListAssetBundleImportJobsPublisher publisher = client.listAssetBundleImportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListAssetBundleImportJobsPublisher publisher = client.listAssetBundleImportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssetBundleImportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsRequest)operation.
This is a convenience which creates an instance of the
ListAssetBundleImportJobsRequest.Builderavoiding the need to create one manually viaListAssetBundleImportJobsRequest.builder()- Parameters:
listAssetBundleImportJobsRequest- AConsumerthat will call methods onListAssetBundleImportJobsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBrands
Lists all brands in an Quick Sight account.
- Parameters:
listBrandsRequest-- Returns:
- A Java Future containing the result of the ListBrands operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InternalServerException An internal service exception.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBrands
default CompletableFuture<ListBrandsResponse> listBrands(Consumer<ListBrandsRequest.Builder> listBrandsRequest) Lists all brands in an Quick Sight account.
This is a convenience which creates an instance of the
ListBrandsRequest.Builderavoiding the need to create one manually viaListBrandsRequest.builder()- Parameters:
listBrandsRequest- AConsumerthat will call methods onListBrandsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListBrands operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InternalServerException An internal service exception.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBrandsPaginator
This is a variant of
listBrands(software.amazon.awssdk.services.quicksight.model.ListBrandsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListBrandsPublisher publisher = client.listBrandsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListBrandsPublisher publisher = client.listBrandsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListBrandsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListBrandsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBrands(software.amazon.awssdk.services.quicksight.model.ListBrandsRequest)operation.- Parameters:
listBrandsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InternalServerException An internal service exception.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBrandsPaginator
default ListBrandsPublisher listBrandsPaginator(Consumer<ListBrandsRequest.Builder> listBrandsRequest) This is a variant of
listBrands(software.amazon.awssdk.services.quicksight.model.ListBrandsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListBrandsPublisher publisher = client.listBrandsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListBrandsPublisher publisher = client.listBrandsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListBrandsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListBrandsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBrands(software.amazon.awssdk.services.quicksight.model.ListBrandsRequest)operation.
This is a convenience which creates an instance of the
ListBrandsRequest.Builderavoiding the need to create one manually viaListBrandsRequest.builder()- Parameters:
listBrandsRequest- AConsumerthat will call methods onListBrandsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InternalServerException An internal service exception.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomPermissions
default CompletableFuture<ListCustomPermissionsResponse> listCustomPermissions(ListCustomPermissionsRequest listCustomPermissionsRequest) Returns a list of all the custom permissions profiles.
- Parameters:
listCustomPermissionsRequest-- Returns:
- A Java Future containing the result of the ListCustomPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomPermissions
default CompletableFuture<ListCustomPermissionsResponse> listCustomPermissions(Consumer<ListCustomPermissionsRequest.Builder> listCustomPermissionsRequest) Returns a list of all the custom permissions profiles.
This is a convenience which creates an instance of the
ListCustomPermissionsRequest.Builderavoiding the need to create one manually viaListCustomPermissionsRequest.builder()- Parameters:
listCustomPermissionsRequest- AConsumerthat will call methods onListCustomPermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListCustomPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomPermissionsPaginator
default ListCustomPermissionsPublisher listCustomPermissionsPaginator(ListCustomPermissionsRequest listCustomPermissionsRequest) This is a variant of
listCustomPermissions(software.amazon.awssdk.services.quicksight.model.ListCustomPermissionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListCustomPermissionsPublisher publisher = client.listCustomPermissionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListCustomPermissionsPublisher publisher = client.listCustomPermissionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListCustomPermissionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListCustomPermissionsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCustomPermissions(software.amazon.awssdk.services.quicksight.model.ListCustomPermissionsRequest)operation.- Parameters:
listCustomPermissionsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomPermissionsPaginator
default ListCustomPermissionsPublisher listCustomPermissionsPaginator(Consumer<ListCustomPermissionsRequest.Builder> listCustomPermissionsRequest) This is a variant of
listCustomPermissions(software.amazon.awssdk.services.quicksight.model.ListCustomPermissionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListCustomPermissionsPublisher publisher = client.listCustomPermissionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListCustomPermissionsPublisher publisher = client.listCustomPermissionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListCustomPermissionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListCustomPermissionsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCustomPermissions(software.amazon.awssdk.services.quicksight.model.ListCustomPermissionsRequest)operation.
This is a convenience which creates an instance of the
ListCustomPermissionsRequest.Builderavoiding the need to create one manually viaListCustomPermissionsRequest.builder()- Parameters:
listCustomPermissionsRequest- AConsumerthat will call methods onListCustomPermissionsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDashboardVersions
default CompletableFuture<ListDashboardVersionsResponse> listDashboardVersions(ListDashboardVersionsRequest listDashboardVersionsRequest) Lists all the versions of the dashboards in the Amazon Quick Sight subscription.
- Parameters:
listDashboardVersionsRequest-- Returns:
- A Java Future containing the result of the ListDashboardVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDashboardVersions
default CompletableFuture<ListDashboardVersionsResponse> listDashboardVersions(Consumer<ListDashboardVersionsRequest.Builder> listDashboardVersionsRequest) Lists all the versions of the dashboards in the Amazon Quick Sight subscription.
This is a convenience which creates an instance of the
ListDashboardVersionsRequest.Builderavoiding the need to create one manually viaListDashboardVersionsRequest.builder()- Parameters:
listDashboardVersionsRequest- AConsumerthat will call methods onListDashboardVersionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListDashboardVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDashboardVersionsPaginator
default ListDashboardVersionsPublisher listDashboardVersionsPaginator(ListDashboardVersionsRequest listDashboardVersionsRequest) This is a variant of
listDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsPublisher publisher = client.listDashboardVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsPublisher publisher = client.listDashboardVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest)operation.- Parameters:
listDashboardVersionsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDashboardVersionsPaginator
default ListDashboardVersionsPublisher listDashboardVersionsPaginator(Consumer<ListDashboardVersionsRequest.Builder> listDashboardVersionsRequest) This is a variant of
listDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsPublisher publisher = client.listDashboardVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsPublisher publisher = client.listDashboardVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest)operation.
This is a convenience which creates an instance of the
ListDashboardVersionsRequest.Builderavoiding the need to create one manually viaListDashboardVersionsRequest.builder()- Parameters:
listDashboardVersionsRequest- AConsumerthat will call methods onListDashboardVersionsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDashboards
default CompletableFuture<ListDashboardsResponse> listDashboards(ListDashboardsRequest listDashboardsRequest) Lists dashboards in an Amazon Web Services account.
- Parameters:
listDashboardsRequest-- Returns:
- A Java Future containing the result of the ListDashboards operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDashboards
default CompletableFuture<ListDashboardsResponse> listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest) Lists dashboards in an Amazon Web Services account.
This is a convenience which creates an instance of the
ListDashboardsRequest.Builderavoiding the need to create one manually viaListDashboardsRequest.builder()- Parameters:
listDashboardsRequest- AConsumerthat will call methods onListDashboardsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListDashboards operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDashboardsPaginator
default ListDashboardsPublisher listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest) This is a variant of
listDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListDashboardsPublisher publisher = client.listDashboardsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListDashboardsPublisher publisher = client.listDashboardsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListDashboardsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListDashboardsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest)operation.- Parameters:
listDashboardsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDashboardsPaginator
default ListDashboardsPublisher listDashboardsPaginator(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest) This is a variant of
listDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListDashboardsPublisher publisher = client.listDashboardsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListDashboardsPublisher publisher = client.listDashboardsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListDashboardsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListDashboardsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest)operation.
This is a convenience which creates an instance of the
ListDashboardsRequest.Builderavoiding the need to create one manually viaListDashboardsRequest.builder()- Parameters:
listDashboardsRequest- AConsumerthat will call methods onListDashboardsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataSets
default CompletableFuture<ListDataSetsResponse> listDataSets(ListDataSetsRequest listDataSetsRequest) Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
The permissions resource is
arn:aws:quicksight:region:aws-account-id:dataset/*.- Parameters:
listDataSetsRequest-- Returns:
- A Java Future containing the result of the ListDataSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataSets
default CompletableFuture<ListDataSetsResponse> listDataSets(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest) Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
The permissions resource is
arn:aws:quicksight:region:aws-account-id:dataset/*.
This is a convenience which creates an instance of the
ListDataSetsRequest.Builderavoiding the need to create one manually viaListDataSetsRequest.builder()- Parameters:
listDataSetsRequest- AConsumerthat will call methods onListDataSetsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListDataSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataSetsPaginator
This is a variant of
listDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListDataSetsPublisher publisher = client.listDataSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListDataSetsPublisher publisher = client.listDataSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListDataSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListDataSetsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest)operation.- Parameters:
listDataSetsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataSetsPaginator
default ListDataSetsPublisher listDataSetsPaginator(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest) This is a variant of
listDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListDataSetsPublisher publisher = client.listDataSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListDataSetsPublisher publisher = client.listDataSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListDataSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListDataSetsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest)operation.
This is a convenience which creates an instance of the
ListDataSetsRequest.Builderavoiding the need to create one manually viaListDataSetsRequest.builder()- Parameters:
listDataSetsRequest- AConsumerthat will call methods onListDataSetsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataSources
default CompletableFuture<ListDataSourcesResponse> listDataSources(ListDataSourcesRequest listDataSourcesRequest) Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
- Parameters:
listDataSourcesRequest-- Returns:
- A Java Future containing the result of the ListDataSources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataSources
default CompletableFuture<ListDataSourcesResponse> listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
This is a convenience which creates an instance of the
ListDataSourcesRequest.Builderavoiding the need to create one manually viaListDataSourcesRequest.builder()- Parameters:
listDataSourcesRequest- AConsumerthat will call methods onListDataSourcesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListDataSources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataSourcesPaginator
default ListDataSourcesPublisher listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest) This is a variant of
listDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListDataSourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListDataSourcesResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest)operation.- Parameters:
listDataSourcesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataSourcesPaginator
default ListDataSourcesPublisher listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) This is a variant of
listDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListDataSourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListDataSourcesResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest)operation.
This is a convenience which creates an instance of the
ListDataSourcesRequest.Builderavoiding the need to create one manually viaListDataSourcesRequest.builder()- Parameters:
listDataSourcesRequest- AConsumerthat will call methods onListDataSourcesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFlows
Lists flows in an Amazon Web Services account.
- Parameters:
listFlowsRequest-- Returns:
- A Java Future containing the result of the ListFlows operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFlows
default CompletableFuture<ListFlowsResponse> listFlows(Consumer<ListFlowsRequest.Builder> listFlowsRequest) Lists flows in an Amazon Web Services account.
This is a convenience which creates an instance of the
ListFlowsRequest.Builderavoiding the need to create one manually viaListFlowsRequest.builder()- Parameters:
listFlowsRequest- AConsumerthat will call methods onListFlowsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListFlows operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFlowsPaginator
This is a variant of
listFlows(software.amazon.awssdk.services.quicksight.model.ListFlowsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListFlowsPublisher publisher = client.listFlowsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListFlowsPublisher publisher = client.listFlowsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListFlowsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListFlowsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFlows(software.amazon.awssdk.services.quicksight.model.ListFlowsRequest)operation.- Parameters:
listFlowsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFlowsPaginator
This is a variant of
listFlows(software.amazon.awssdk.services.quicksight.model.ListFlowsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListFlowsPublisher publisher = client.listFlowsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListFlowsPublisher publisher = client.listFlowsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListFlowsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListFlowsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFlows(software.amazon.awssdk.services.quicksight.model.ListFlowsRequest)operation.
This is a convenience which creates an instance of the
ListFlowsRequest.Builderavoiding the need to create one manually viaListFlowsRequest.builder()- Parameters:
listFlowsRequest- AConsumerthat will call methods onListFlowsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFolderMembers
default CompletableFuture<ListFolderMembersResponse> listFolderMembers(ListFolderMembersRequest listFolderMembersRequest) List all assets (
DASHBOARD,ANALYSIS, andDATASET) in a folder.- Parameters:
listFolderMembersRequest-- Returns:
- A Java Future containing the result of the ListFolderMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFolderMembers
default CompletableFuture<ListFolderMembersResponse> listFolderMembers(Consumer<ListFolderMembersRequest.Builder> listFolderMembersRequest) List all assets (
DASHBOARD,ANALYSIS, andDATASET) in a folder.
This is a convenience which creates an instance of the
ListFolderMembersRequest.Builderavoiding the need to create one manually viaListFolderMembersRequest.builder()- Parameters:
listFolderMembersRequest- AConsumerthat will call methods onListFolderMembersRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListFolderMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFolderMembersPaginator
default ListFolderMembersPublisher listFolderMembersPaginator(ListFolderMembersRequest listFolderMembersRequest) This is a variant of
listFolderMembers(software.amazon.awssdk.services.quicksight.model.ListFolderMembersRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListFolderMembersPublisher publisher = client.listFolderMembersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListFolderMembersPublisher publisher = client.listFolderMembersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListFolderMembersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListFolderMembersResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFolderMembers(software.amazon.awssdk.services.quicksight.model.ListFolderMembersRequest)operation.- Parameters:
listFolderMembersRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFolderMembersPaginator
default ListFolderMembersPublisher listFolderMembersPaginator(Consumer<ListFolderMembersRequest.Builder> listFolderMembersRequest) This is a variant of
listFolderMembers(software.amazon.awssdk.services.quicksight.model.ListFolderMembersRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListFolderMembersPublisher publisher = client.listFolderMembersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListFolderMembersPublisher publisher = client.listFolderMembersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListFolderMembersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListFolderMembersResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFolderMembers(software.amazon.awssdk.services.quicksight.model.ListFolderMembersRequest)operation.
This is a convenience which creates an instance of the
ListFolderMembersRequest.Builderavoiding the need to create one manually viaListFolderMembersRequest.builder()- Parameters:
listFolderMembersRequest- AConsumerthat will call methods onListFolderMembersRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFolders
Lists all folders in an account.
- Parameters:
listFoldersRequest-- Returns:
- A Java Future containing the result of the ListFolders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFolders
default CompletableFuture<ListFoldersResponse> listFolders(Consumer<ListFoldersRequest.Builder> listFoldersRequest) Lists all folders in an account.
This is a convenience which creates an instance of the
ListFoldersRequest.Builderavoiding the need to create one manually viaListFoldersRequest.builder()- Parameters:
listFoldersRequest- AConsumerthat will call methods onListFoldersRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListFolders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFoldersForResource
default CompletableFuture<ListFoldersForResourceResponse> listFoldersForResource(ListFoldersForResourceRequest listFoldersForResourceRequest) List all folders that a resource is a member of.
- Parameters:
listFoldersForResourceRequest-- Returns:
- A Java Future containing the result of the ListFoldersForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFoldersForResource
default CompletableFuture<ListFoldersForResourceResponse> listFoldersForResource(Consumer<ListFoldersForResourceRequest.Builder> listFoldersForResourceRequest) List all folders that a resource is a member of.
This is a convenience which creates an instance of the
ListFoldersForResourceRequest.Builderavoiding the need to create one manually viaListFoldersForResourceRequest.builder()- Parameters:
listFoldersForResourceRequest- AConsumerthat will call methods onListFoldersForResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListFoldersForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFoldersForResourcePaginator
default ListFoldersForResourcePublisher listFoldersForResourcePaginator(ListFoldersForResourceRequest listFoldersForResourceRequest) This is a variant of
listFoldersForResource(software.amazon.awssdk.services.quicksight.model.ListFoldersForResourceRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListFoldersForResourcePublisher publisher = client.listFoldersForResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListFoldersForResourcePublisher publisher = client.listFoldersForResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListFoldersForResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListFoldersForResourceResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFoldersForResource(software.amazon.awssdk.services.quicksight.model.ListFoldersForResourceRequest)operation.- Parameters:
listFoldersForResourceRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFoldersForResourcePaginator
default ListFoldersForResourcePublisher listFoldersForResourcePaginator(Consumer<ListFoldersForResourceRequest.Builder> listFoldersForResourceRequest) This is a variant of
listFoldersForResource(software.amazon.awssdk.services.quicksight.model.ListFoldersForResourceRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListFoldersForResourcePublisher publisher = client.listFoldersForResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListFoldersForResourcePublisher publisher = client.listFoldersForResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListFoldersForResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListFoldersForResourceResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFoldersForResource(software.amazon.awssdk.services.quicksight.model.ListFoldersForResourceRequest)operation.
This is a convenience which creates an instance of the
ListFoldersForResourceRequest.Builderavoiding the need to create one manually viaListFoldersForResourceRequest.builder()- Parameters:
listFoldersForResourceRequest- AConsumerthat will call methods onListFoldersForResourceRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFoldersPaginator
This is a variant of
listFolders(software.amazon.awssdk.services.quicksight.model.ListFoldersRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListFoldersPublisher publisher = client.listFoldersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListFoldersPublisher publisher = client.listFoldersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListFoldersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListFoldersResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFolders(software.amazon.awssdk.services.quicksight.model.ListFoldersRequest)operation.- Parameters:
listFoldersRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFoldersPaginator
default ListFoldersPublisher listFoldersPaginator(Consumer<ListFoldersRequest.Builder> listFoldersRequest) This is a variant of
listFolders(software.amazon.awssdk.services.quicksight.model.ListFoldersRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListFoldersPublisher publisher = client.listFoldersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListFoldersPublisher publisher = client.listFoldersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListFoldersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListFoldersResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFolders(software.amazon.awssdk.services.quicksight.model.ListFoldersRequest)operation.
This is a convenience which creates an instance of the
ListFoldersRequest.Builderavoiding the need to create one manually viaListFoldersRequest.builder()- Parameters:
listFoldersRequest- AConsumerthat will call methods onListFoldersRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupMemberships
default CompletableFuture<ListGroupMembershipsResponse> listGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest) Lists member users in a group.
- Parameters:
listGroupMembershipsRequest-- Returns:
- A Java Future containing the result of the ListGroupMemberships operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupMemberships
default CompletableFuture<ListGroupMembershipsResponse> listGroupMemberships(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest) Lists member users in a group.
This is a convenience which creates an instance of the
ListGroupMembershipsRequest.Builderavoiding the need to create one manually viaListGroupMembershipsRequest.builder()- Parameters:
listGroupMembershipsRequest- AConsumerthat will call methods onListGroupMembershipsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListGroupMemberships operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupMembershipsPaginator
default ListGroupMembershipsPublisher listGroupMembershipsPaginator(ListGroupMembershipsRequest listGroupMembershipsRequest) This is a variant of
listGroupMemberships(software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListGroupMembershipsPublisher publisher = client.listGroupMembershipsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListGroupMembershipsPublisher publisher = client.listGroupMembershipsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroupMemberships(software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsRequest)operation.- Parameters:
listGroupMembershipsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupMembershipsPaginator
default ListGroupMembershipsPublisher listGroupMembershipsPaginator(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest) This is a variant of
listGroupMemberships(software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListGroupMembershipsPublisher publisher = client.listGroupMembershipsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListGroupMembershipsPublisher publisher = client.listGroupMembershipsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroupMemberships(software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsRequest)operation.
This is a convenience which creates an instance of the
ListGroupMembershipsRequest.Builderavoiding the need to create one manually viaListGroupMembershipsRequest.builder()- Parameters:
listGroupMembershipsRequest- AConsumerthat will call methods onListGroupMembershipsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroups
Lists all user groups in Amazon Quick Sight.
- Parameters:
listGroupsRequest-- Returns:
- A Java Future containing the result of the ListGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroups
default CompletableFuture<ListGroupsResponse> listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest) Lists all user groups in Amazon Quick Sight.
This is a convenience which creates an instance of the
ListGroupsRequest.Builderavoiding the need to create one manually viaListGroupsRequest.builder()- Parameters:
listGroupsRequest- AConsumerthat will call methods onListGroupsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupsPaginator
This is a variant of
listGroups(software.amazon.awssdk.services.quicksight.model.ListGroupsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListGroupsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.quicksight.model.ListGroupsRequest)operation.- Parameters:
listGroupsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroupsPaginator
default ListGroupsPublisher listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest) This is a variant of
listGroups(software.amazon.awssdk.services.quicksight.model.ListGroupsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListGroupsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.quicksight.model.ListGroupsRequest)operation.
This is a convenience which creates an instance of the
ListGroupsRequest.Builderavoiding the need to create one manually viaListGroupsRequest.builder()- Parameters:
listGroupsRequest- AConsumerthat will call methods onListGroupsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIAMPolicyAssignments
default CompletableFuture<ListIamPolicyAssignmentsResponse> listIAMPolicyAssignments(ListIamPolicyAssignmentsRequest listIamPolicyAssignmentsRequest) Lists the IAM policy assignments in the current Amazon Quick Sight account.
- Parameters:
listIamPolicyAssignmentsRequest-- Returns:
- A Java Future containing the result of the ListIAMPolicyAssignments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIAMPolicyAssignments
default CompletableFuture<ListIamPolicyAssignmentsResponse> listIAMPolicyAssignments(Consumer<ListIamPolicyAssignmentsRequest.Builder> listIamPolicyAssignmentsRequest) Lists the IAM policy assignments in the current Amazon Quick Sight account.
This is a convenience which creates an instance of the
ListIamPolicyAssignmentsRequest.Builderavoiding the need to create one manually viaListIamPolicyAssignmentsRequest.builder()- Parameters:
listIamPolicyAssignmentsRequest- AConsumerthat will call methods onListIamPolicyAssignmentsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListIAMPolicyAssignments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIAMPolicyAssignmentsForUser
default CompletableFuture<ListIamPolicyAssignmentsForUserResponse> listIAMPolicyAssignmentsForUser(ListIamPolicyAssignmentsForUserRequest listIamPolicyAssignmentsForUserRequest) Lists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to.
- Parameters:
listIamPolicyAssignmentsForUserRequest-- Returns:
- A Java Future containing the result of the ListIAMPolicyAssignmentsForUser operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConcurrentUpdatingException A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIAMPolicyAssignmentsForUser
default CompletableFuture<ListIamPolicyAssignmentsForUserResponse> listIAMPolicyAssignmentsForUser(Consumer<ListIamPolicyAssignmentsForUserRequest.Builder> listIamPolicyAssignmentsForUserRequest) Lists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to.
This is a convenience which creates an instance of the
ListIamPolicyAssignmentsForUserRequest.Builderavoiding the need to create one manually viaListIamPolicyAssignmentsForUserRequest.builder()- Parameters:
listIamPolicyAssignmentsForUserRequest- AConsumerthat will call methods onListIamPolicyAssignmentsForUserRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListIAMPolicyAssignmentsForUser operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConcurrentUpdatingException A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIAMPolicyAssignmentsForUserPaginator
default ListIAMPolicyAssignmentsForUserPublisher listIAMPolicyAssignmentsForUserPaginator(ListIamPolicyAssignmentsForUserRequest listIamPolicyAssignmentsForUserRequest) This is a variant of
listIAMPolicyAssignmentsForUser(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsForUserPublisher publisher = client.listIAMPolicyAssignmentsForUserPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsForUserPublisher publisher = client.listIAMPolicyAssignmentsForUserPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIAMPolicyAssignmentsForUser(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserRequest)operation.- Parameters:
listIamPolicyAssignmentsForUserRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConcurrentUpdatingException A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIAMPolicyAssignmentsForUserPaginator
default ListIAMPolicyAssignmentsForUserPublisher listIAMPolicyAssignmentsForUserPaginator(Consumer<ListIamPolicyAssignmentsForUserRequest.Builder> listIamPolicyAssignmentsForUserRequest) This is a variant of
listIAMPolicyAssignmentsForUser(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsForUserPublisher publisher = client.listIAMPolicyAssignmentsForUserPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsForUserPublisher publisher = client.listIAMPolicyAssignmentsForUserPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIAMPolicyAssignmentsForUser(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserRequest)operation.
This is a convenience which creates an instance of the
ListIamPolicyAssignmentsForUserRequest.Builderavoiding the need to create one manually viaListIamPolicyAssignmentsForUserRequest.builder()- Parameters:
listIamPolicyAssignmentsForUserRequest- AConsumerthat will call methods onListIamPolicyAssignmentsForUserRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConcurrentUpdatingException A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIAMPolicyAssignmentsPaginator
default ListIAMPolicyAssignmentsPublisher listIAMPolicyAssignmentsPaginator(ListIamPolicyAssignmentsRequest listIamPolicyAssignmentsRequest) This is a variant of
listIAMPolicyAssignments(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsPublisher publisher = client.listIAMPolicyAssignmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsPublisher publisher = client.listIAMPolicyAssignmentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIAMPolicyAssignments(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsRequest)operation.- Parameters:
listIamPolicyAssignmentsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIAMPolicyAssignmentsPaginator
default ListIAMPolicyAssignmentsPublisher listIAMPolicyAssignmentsPaginator(Consumer<ListIamPolicyAssignmentsRequest.Builder> listIamPolicyAssignmentsRequest) This is a variant of
listIAMPolicyAssignments(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsPublisher publisher = client.listIAMPolicyAssignmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsPublisher publisher = client.listIAMPolicyAssignmentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIAMPolicyAssignments(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsRequest)operation.
This is a convenience which creates an instance of the
ListIamPolicyAssignmentsRequest.Builderavoiding the need to create one manually viaListIamPolicyAssignmentsRequest.builder()- Parameters:
listIamPolicyAssignmentsRequest- AConsumerthat will call methods onListIamPolicyAssignmentsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIdentityPropagationConfigs
default CompletableFuture<ListIdentityPropagationConfigsResponse> listIdentityPropagationConfigs(ListIdentityPropagationConfigsRequest listIdentityPropagationConfigsRequest) Lists all services and authorized targets that the Quick Sight IAM Identity Center application can access.
This operation is only supported for Quick Sight accounts that use IAM Identity Center.
- Parameters:
listIdentityPropagationConfigsRequest-- Returns:
- A Java Future containing the result of the ListIdentityPropagationConfigs operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIdentityPropagationConfigs
default CompletableFuture<ListIdentityPropagationConfigsResponse> listIdentityPropagationConfigs(Consumer<ListIdentityPropagationConfigsRequest.Builder> listIdentityPropagationConfigsRequest) Lists all services and authorized targets that the Quick Sight IAM Identity Center application can access.
This operation is only supported for Quick Sight accounts that use IAM Identity Center.
This is a convenience which creates an instance of the
ListIdentityPropagationConfigsRequest.Builderavoiding the need to create one manually viaListIdentityPropagationConfigsRequest.builder()- Parameters:
listIdentityPropagationConfigsRequest- AConsumerthat will call methods onListIdentityPropagationConfigsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListIdentityPropagationConfigs operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIngestions
default CompletableFuture<ListIngestionsResponse> listIngestions(ListIngestionsRequest listIngestionsRequest) Lists the history of SPICE ingestions for a dataset. Limited to 5 TPS per user and 25 TPS per account.
- Parameters:
listIngestionsRequest-- Returns:
- A Java Future containing the result of the ListIngestions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIngestions
default CompletableFuture<ListIngestionsResponse> listIngestions(Consumer<ListIngestionsRequest.Builder> listIngestionsRequest) Lists the history of SPICE ingestions for a dataset. Limited to 5 TPS per user and 25 TPS per account.
This is a convenience which creates an instance of the
ListIngestionsRequest.Builderavoiding the need to create one manually viaListIngestionsRequest.builder()- Parameters:
listIngestionsRequest- AConsumerthat will call methods onListIngestionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListIngestions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIngestionsPaginator
default ListIngestionsPublisher listIngestionsPaginator(ListIngestionsRequest listIngestionsRequest) This is a variant of
listIngestions(software.amazon.awssdk.services.quicksight.model.ListIngestionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListIngestionsPublisher publisher = client.listIngestionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListIngestionsPublisher publisher = client.listIngestionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListIngestionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListIngestionsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIngestions(software.amazon.awssdk.services.quicksight.model.ListIngestionsRequest)operation.- Parameters:
listIngestionsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIngestionsPaginator
default ListIngestionsPublisher listIngestionsPaginator(Consumer<ListIngestionsRequest.Builder> listIngestionsRequest) This is a variant of
listIngestions(software.amazon.awssdk.services.quicksight.model.ListIngestionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListIngestionsPublisher publisher = client.listIngestionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListIngestionsPublisher publisher = client.listIngestionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListIngestionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListIngestionsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIngestions(software.amazon.awssdk.services.quicksight.model.ListIngestionsRequest)operation.
This is a convenience which creates an instance of the
ListIngestionsRequest.Builderavoiding the need to create one manually viaListIngestionsRequest.builder()- Parameters:
listIngestionsRequest- AConsumerthat will call methods onListIngestionsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNamespaces
default CompletableFuture<ListNamespacesResponse> listNamespaces(ListNamespacesRequest listNamespacesRequest) Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.
- Parameters:
listNamespacesRequest-- Returns:
- A Java Future containing the result of the ListNamespaces operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNamespaces
default CompletableFuture<ListNamespacesResponse> listNamespaces(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest) Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.
This is a convenience which creates an instance of the
ListNamespacesRequest.Builderavoiding the need to create one manually viaListNamespacesRequest.builder()- Parameters:
listNamespacesRequest- AConsumerthat will call methods onListNamespacesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListNamespaces operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNamespacesPaginator
default ListNamespacesPublisher listNamespacesPaginator(ListNamespacesRequest listNamespacesRequest) This is a variant of
listNamespaces(software.amazon.awssdk.services.quicksight.model.ListNamespacesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListNamespacesPublisher publisher = client.listNamespacesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListNamespacesPublisher publisher = client.listNamespacesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListNamespacesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListNamespacesResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNamespaces(software.amazon.awssdk.services.quicksight.model.ListNamespacesRequest)operation.- Parameters:
listNamespacesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNamespacesPaginator
default ListNamespacesPublisher listNamespacesPaginator(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest) This is a variant of
listNamespaces(software.amazon.awssdk.services.quicksight.model.ListNamespacesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListNamespacesPublisher publisher = client.listNamespacesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListNamespacesPublisher publisher = client.listNamespacesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListNamespacesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListNamespacesResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNamespaces(software.amazon.awssdk.services.quicksight.model.ListNamespacesRequest)operation.
This is a convenience which creates an instance of the
ListNamespacesRequest.Builderavoiding the need to create one manually viaListNamespacesRequest.builder()- Parameters:
listNamespacesRequest- AConsumerthat will call methods onListNamespacesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRefreshSchedules
default CompletableFuture<ListRefreshSchedulesResponse> listRefreshSchedules(ListRefreshSchedulesRequest listRefreshSchedulesRequest) Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.
- Parameters:
listRefreshSchedulesRequest-- Returns:
- A Java Future containing the result of the ListRefreshSchedules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRefreshSchedules
default CompletableFuture<ListRefreshSchedulesResponse> listRefreshSchedules(Consumer<ListRefreshSchedulesRequest.Builder> listRefreshSchedulesRequest) Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.
This is a convenience which creates an instance of the
ListRefreshSchedulesRequest.Builderavoiding the need to create one manually viaListRefreshSchedulesRequest.builder()- Parameters:
listRefreshSchedulesRequest- AConsumerthat will call methods onListRefreshSchedulesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListRefreshSchedules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRoleMemberships
default CompletableFuture<ListRoleMembershipsResponse> listRoleMemberships(ListRoleMembershipsRequest listRoleMembershipsRequest) Lists all groups that are associated with a role.
- Parameters:
listRoleMembershipsRequest-- Returns:
- A Java Future containing the result of the ListRoleMemberships operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRoleMemberships
default CompletableFuture<ListRoleMembershipsResponse> listRoleMemberships(Consumer<ListRoleMembershipsRequest.Builder> listRoleMembershipsRequest) Lists all groups that are associated with a role.
This is a convenience which creates an instance of the
ListRoleMembershipsRequest.Builderavoiding the need to create one manually viaListRoleMembershipsRequest.builder()- Parameters:
listRoleMembershipsRequest- AConsumerthat will call methods onListRoleMembershipsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListRoleMemberships operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRoleMembershipsPaginator
default ListRoleMembershipsPublisher listRoleMembershipsPaginator(ListRoleMembershipsRequest listRoleMembershipsRequest) This is a variant of
listRoleMemberships(software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListRoleMembershipsPublisher publisher = client.listRoleMembershipsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListRoleMembershipsPublisher publisher = client.listRoleMembershipsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRoleMemberships(software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsRequest)operation.- Parameters:
listRoleMembershipsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRoleMembershipsPaginator
default ListRoleMembershipsPublisher listRoleMembershipsPaginator(Consumer<ListRoleMembershipsRequest.Builder> listRoleMembershipsRequest) This is a variant of
listRoleMemberships(software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListRoleMembershipsPublisher publisher = client.listRoleMembershipsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListRoleMembershipsPublisher publisher = client.listRoleMembershipsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRoleMemberships(software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsRequest)operation.
This is a convenience which creates an instance of the
ListRoleMembershipsRequest.Builderavoiding the need to create one manually viaListRoleMembershipsRequest.builder()- Parameters:
listRoleMembershipsRequest- AConsumerthat will call methods onListRoleMembershipsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags assigned to a resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags assigned to a resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTemplateAliases
default CompletableFuture<ListTemplateAliasesResponse> listTemplateAliases(ListTemplateAliasesRequest listTemplateAliasesRequest) Lists all the aliases of a template.
- Parameters:
listTemplateAliasesRequest-- Returns:
- A Java Future containing the result of the ListTemplateAliases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidNextTokenException The
NextTokenvalue isn't valid. - ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidNextTokenException The
- See Also:
-
listTemplateAliases
default CompletableFuture<ListTemplateAliasesResponse> listTemplateAliases(Consumer<ListTemplateAliasesRequest.Builder> listTemplateAliasesRequest) Lists all the aliases of a template.
This is a convenience which creates an instance of the
ListTemplateAliasesRequest.Builderavoiding the need to create one manually viaListTemplateAliasesRequest.builder()- Parameters:
listTemplateAliasesRequest- AConsumerthat will call methods onListTemplateAliasesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTemplateAliases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidNextTokenException The
NextTokenvalue isn't valid. - ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidNextTokenException The
- See Also:
-
listTemplateAliasesPaginator
default ListTemplateAliasesPublisher listTemplateAliasesPaginator(ListTemplateAliasesRequest listTemplateAliasesRequest) This is a variant of
listTemplateAliases(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesPublisher publisher = client.listTemplateAliasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesPublisher publisher = client.listTemplateAliasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplateAliases(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesRequest)operation.- Parameters:
listTemplateAliasesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidNextTokenException The
NextTokenvalue isn't valid. - ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidNextTokenException The
- See Also:
-
listTemplateAliasesPaginator
default ListTemplateAliasesPublisher listTemplateAliasesPaginator(Consumer<ListTemplateAliasesRequest.Builder> listTemplateAliasesRequest) This is a variant of
listTemplateAliases(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesPublisher publisher = client.listTemplateAliasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesPublisher publisher = client.listTemplateAliasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplateAliases(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesRequest)operation.
This is a convenience which creates an instance of the
ListTemplateAliasesRequest.Builderavoiding the need to create one manually viaListTemplateAliasesRequest.builder()- Parameters:
listTemplateAliasesRequest- AConsumerthat will call methods onListTemplateAliasesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidNextTokenException The
NextTokenvalue isn't valid. - ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidNextTokenException The
- See Also:
-
listTemplateVersions
default CompletableFuture<ListTemplateVersionsResponse> listTemplateVersions(ListTemplateVersionsRequest listTemplateVersionsRequest) Lists all the versions of the templates in the current Amazon Quick Sight account.
- Parameters:
listTemplateVersionsRequest-- Returns:
- A Java Future containing the result of the ListTemplateVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTemplateVersions
default CompletableFuture<ListTemplateVersionsResponse> listTemplateVersions(Consumer<ListTemplateVersionsRequest.Builder> listTemplateVersionsRequest) Lists all the versions of the templates in the current Amazon Quick Sight account.
This is a convenience which creates an instance of the
ListTemplateVersionsRequest.Builderavoiding the need to create one manually viaListTemplateVersionsRequest.builder()- Parameters:
listTemplateVersionsRequest- AConsumerthat will call methods onListTemplateVersionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTemplateVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTemplateVersionsPaginator
default ListTemplateVersionsPublisher listTemplateVersionsPaginator(ListTemplateVersionsRequest listTemplateVersionsRequest) This is a variant of
listTemplateVersions(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsPublisher publisher = client.listTemplateVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsPublisher publisher = client.listTemplateVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplateVersions(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsRequest)operation.- Parameters:
listTemplateVersionsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTemplateVersionsPaginator
default ListTemplateVersionsPublisher listTemplateVersionsPaginator(Consumer<ListTemplateVersionsRequest.Builder> listTemplateVersionsRequest) This is a variant of
listTemplateVersions(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsPublisher publisher = client.listTemplateVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsPublisher publisher = client.listTemplateVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplateVersions(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsRequest)operation.
This is a convenience which creates an instance of the
ListTemplateVersionsRequest.Builderavoiding the need to create one manually viaListTemplateVersionsRequest.builder()- Parameters:
listTemplateVersionsRequest- AConsumerthat will call methods onListTemplateVersionsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTemplates
default CompletableFuture<ListTemplatesResponse> listTemplates(ListTemplatesRequest listTemplatesRequest) Lists all the templates in the current Amazon Quick Sight account.
- Parameters:
listTemplatesRequest-- Returns:
- A Java Future containing the result of the ListTemplates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTemplates
default CompletableFuture<ListTemplatesResponse> listTemplates(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest) Lists all the templates in the current Amazon Quick Sight account.
This is a convenience which creates an instance of the
ListTemplatesRequest.Builderavoiding the need to create one manually viaListTemplatesRequest.builder()- Parameters:
listTemplatesRequest- AConsumerthat will call methods onListTemplatesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTemplates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTemplatesPaginator
This is a variant of
listTemplates(software.amazon.awssdk.services.quicksight.model.ListTemplatesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListTemplatesPublisher publisher = client.listTemplatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListTemplatesPublisher publisher = client.listTemplatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListTemplatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListTemplatesResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplates(software.amazon.awssdk.services.quicksight.model.ListTemplatesRequest)operation.- Parameters:
listTemplatesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTemplatesPaginator
default ListTemplatesPublisher listTemplatesPaginator(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest) This is a variant of
listTemplates(software.amazon.awssdk.services.quicksight.model.ListTemplatesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListTemplatesPublisher publisher = client.listTemplatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListTemplatesPublisher publisher = client.listTemplatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListTemplatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListTemplatesResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplates(software.amazon.awssdk.services.quicksight.model.ListTemplatesRequest)operation.
This is a convenience which creates an instance of the
ListTemplatesRequest.Builderavoiding the need to create one manually viaListTemplatesRequest.builder()- Parameters:
listTemplatesRequest- AConsumerthat will call methods onListTemplatesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listThemeAliases
default CompletableFuture<ListThemeAliasesResponse> listThemeAliases(ListThemeAliasesRequest listThemeAliasesRequest) Lists all the aliases of a theme.
- Parameters:
listThemeAliasesRequest-- Returns:
- A Java Future containing the result of the ListThemeAliases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listThemeAliases
default CompletableFuture<ListThemeAliasesResponse> listThemeAliases(Consumer<ListThemeAliasesRequest.Builder> listThemeAliasesRequest) Lists all the aliases of a theme.
This is a convenience which creates an instance of the
ListThemeAliasesRequest.Builderavoiding the need to create one manually viaListThemeAliasesRequest.builder()- Parameters:
listThemeAliasesRequest- AConsumerthat will call methods onListThemeAliasesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListThemeAliases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listThemeVersions
default CompletableFuture<ListThemeVersionsResponse> listThemeVersions(ListThemeVersionsRequest listThemeVersionsRequest) Lists all the versions of the themes in the current Amazon Web Services account.
- Parameters:
listThemeVersionsRequest-- Returns:
- A Java Future containing the result of the ListThemeVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listThemeVersions
default CompletableFuture<ListThemeVersionsResponse> listThemeVersions(Consumer<ListThemeVersionsRequest.Builder> listThemeVersionsRequest) Lists all the versions of the themes in the current Amazon Web Services account.
This is a convenience which creates an instance of the
ListThemeVersionsRequest.Builderavoiding the need to create one manually viaListThemeVersionsRequest.builder()- Parameters:
listThemeVersionsRequest- AConsumerthat will call methods onListThemeVersionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListThemeVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listThemeVersionsPaginator
default ListThemeVersionsPublisher listThemeVersionsPaginator(ListThemeVersionsRequest listThemeVersionsRequest) This is a variant of
listThemeVersions(software.amazon.awssdk.services.quicksight.model.ListThemeVersionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListThemeVersionsPublisher publisher = client.listThemeVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListThemeVersionsPublisher publisher = client.listThemeVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListThemeVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListThemeVersionsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThemeVersions(software.amazon.awssdk.services.quicksight.model.ListThemeVersionsRequest)operation.- Parameters:
listThemeVersionsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listThemeVersionsPaginator
default ListThemeVersionsPublisher listThemeVersionsPaginator(Consumer<ListThemeVersionsRequest.Builder> listThemeVersionsRequest) This is a variant of
listThemeVersions(software.amazon.awssdk.services.quicksight.model.ListThemeVersionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListThemeVersionsPublisher publisher = client.listThemeVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListThemeVersionsPublisher publisher = client.listThemeVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListThemeVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListThemeVersionsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThemeVersions(software.amazon.awssdk.services.quicksight.model.ListThemeVersionsRequest)operation.
This is a convenience which creates an instance of the
ListThemeVersionsRequest.Builderavoiding the need to create one manually viaListThemeVersionsRequest.builder()- Parameters:
listThemeVersionsRequest- AConsumerthat will call methods onListThemeVersionsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listThemes
Lists all the themes in the current Amazon Web Services account.
- Parameters:
listThemesRequest-- Returns:
- A Java Future containing the result of the ListThemes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listThemes
default CompletableFuture<ListThemesResponse> listThemes(Consumer<ListThemesRequest.Builder> listThemesRequest) Lists all the themes in the current Amazon Web Services account.
This is a convenience which creates an instance of the
ListThemesRequest.Builderavoiding the need to create one manually viaListThemesRequest.builder()- Parameters:
listThemesRequest- AConsumerthat will call methods onListThemesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListThemes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listThemesPaginator
This is a variant of
listThemes(software.amazon.awssdk.services.quicksight.model.ListThemesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListThemesPublisher publisher = client.listThemesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListThemesPublisher publisher = client.listThemesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListThemesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListThemesResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThemes(software.amazon.awssdk.services.quicksight.model.ListThemesRequest)operation.- Parameters:
listThemesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listThemesPaginator
default ListThemesPublisher listThemesPaginator(Consumer<ListThemesRequest.Builder> listThemesRequest) This is a variant of
listThemes(software.amazon.awssdk.services.quicksight.model.ListThemesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListThemesPublisher publisher = client.listThemesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListThemesPublisher publisher = client.listThemesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListThemesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListThemesResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThemes(software.amazon.awssdk.services.quicksight.model.ListThemesRequest)operation.
This is a convenience which creates an instance of the
ListThemesRequest.Builderavoiding the need to create one manually viaListThemesRequest.builder()- Parameters:
listThemesRequest- AConsumerthat will call methods onListThemesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTopicRefreshSchedules
default CompletableFuture<ListTopicRefreshSchedulesResponse> listTopicRefreshSchedules(ListTopicRefreshSchedulesRequest listTopicRefreshSchedulesRequest) Lists all of the refresh schedules for a topic.
- Parameters:
listTopicRefreshSchedulesRequest-- Returns:
- A Java Future containing the result of the ListTopicRefreshSchedules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTopicRefreshSchedules
default CompletableFuture<ListTopicRefreshSchedulesResponse> listTopicRefreshSchedules(Consumer<ListTopicRefreshSchedulesRequest.Builder> listTopicRefreshSchedulesRequest) Lists all of the refresh schedules for a topic.
This is a convenience which creates an instance of the
ListTopicRefreshSchedulesRequest.Builderavoiding the need to create one manually viaListTopicRefreshSchedulesRequest.builder()- Parameters:
listTopicRefreshSchedulesRequest- AConsumerthat will call methods onListTopicRefreshSchedulesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTopicRefreshSchedules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTopicReviewedAnswers
default CompletableFuture<ListTopicReviewedAnswersResponse> listTopicReviewedAnswers(ListTopicReviewedAnswersRequest listTopicReviewedAnswersRequest) Lists all reviewed answers for a Q Topic.
- Parameters:
listTopicReviewedAnswersRequest-- Returns:
- A Java Future containing the result of the ListTopicReviewedAnswers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTopicReviewedAnswers
default CompletableFuture<ListTopicReviewedAnswersResponse> listTopicReviewedAnswers(Consumer<ListTopicReviewedAnswersRequest.Builder> listTopicReviewedAnswersRequest) Lists all reviewed answers for a Q Topic.
This is a convenience which creates an instance of the
ListTopicReviewedAnswersRequest.Builderavoiding the need to create one manually viaListTopicReviewedAnswersRequest.builder()- Parameters:
listTopicReviewedAnswersRequest- AConsumerthat will call methods onListTopicReviewedAnswersRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTopicReviewedAnswers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTopics
Lists all of the topics within an account.
- Parameters:
listTopicsRequest-- Returns:
- A Java Future containing the result of the ListTopics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTopics
default CompletableFuture<ListTopicsResponse> listTopics(Consumer<ListTopicsRequest.Builder> listTopicsRequest) Lists all of the topics within an account.
This is a convenience which creates an instance of the
ListTopicsRequest.Builderavoiding the need to create one manually viaListTopicsRequest.builder()- Parameters:
listTopicsRequest- AConsumerthat will call methods onListTopicsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTopics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTopicsPaginator
This is a variant of
listTopics(software.amazon.awssdk.services.quicksight.model.ListTopicsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListTopicsPublisher publisher = client.listTopicsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListTopicsPublisher publisher = client.listTopicsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListTopicsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListTopicsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTopics(software.amazon.awssdk.services.quicksight.model.ListTopicsRequest)operation.- Parameters:
listTopicsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTopicsPaginator
default ListTopicsPublisher listTopicsPaginator(Consumer<ListTopicsRequest.Builder> listTopicsRequest) This is a variant of
listTopics(software.amazon.awssdk.services.quicksight.model.ListTopicsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListTopicsPublisher publisher = client.listTopicsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListTopicsPublisher publisher = client.listTopicsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListTopicsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListTopicsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTopics(software.amazon.awssdk.services.quicksight.model.ListTopicsRequest)operation.
This is a convenience which creates an instance of the
ListTopicsRequest.Builderavoiding the need to create one manually viaListTopicsRequest.builder()- Parameters:
listTopicsRequest- AConsumerthat will call methods onListTopicsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUserGroups
default CompletableFuture<ListUserGroupsResponse> listUserGroups(ListUserGroupsRequest listUserGroupsRequest) Lists the Amazon Quick Sight groups that an Amazon Quick Sight user is a member of.
- Parameters:
listUserGroupsRequest-- Returns:
- A Java Future containing the result of the ListUserGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUserGroups
default CompletableFuture<ListUserGroupsResponse> listUserGroups(Consumer<ListUserGroupsRequest.Builder> listUserGroupsRequest) Lists the Amazon Quick Sight groups that an Amazon Quick Sight user is a member of.
This is a convenience which creates an instance of the
ListUserGroupsRequest.Builderavoiding the need to create one manually viaListUserGroupsRequest.builder()- Parameters:
listUserGroupsRequest- AConsumerthat will call methods onListUserGroupsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListUserGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUserGroupsPaginator
default ListUserGroupsPublisher listUserGroupsPaginator(ListUserGroupsRequest listUserGroupsRequest) This is a variant of
listUserGroups(software.amazon.awssdk.services.quicksight.model.ListUserGroupsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListUserGroupsPublisher publisher = client.listUserGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListUserGroupsPublisher publisher = client.listUserGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListUserGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListUserGroupsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUserGroups(software.amazon.awssdk.services.quicksight.model.ListUserGroupsRequest)operation.- Parameters:
listUserGroupsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUserGroupsPaginator
default ListUserGroupsPublisher listUserGroupsPaginator(Consumer<ListUserGroupsRequest.Builder> listUserGroupsRequest) This is a variant of
listUserGroups(software.amazon.awssdk.services.quicksight.model.ListUserGroupsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListUserGroupsPublisher publisher = client.listUserGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListUserGroupsPublisher publisher = client.listUserGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListUserGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListUserGroupsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUserGroups(software.amazon.awssdk.services.quicksight.model.ListUserGroupsRequest)operation.
This is a convenience which creates an instance of the
ListUserGroupsRequest.Builderavoiding the need to create one manually viaListUserGroupsRequest.builder()- Parameters:
listUserGroupsRequest- AConsumerthat will call methods onListUserGroupsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUsers
Returns a list of all of the Amazon Quick Sight users belonging to this account.
- Parameters:
listUsersRequest-- Returns:
- A Java Future containing the result of the ListUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUsers
default CompletableFuture<ListUsersResponse> listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) Returns a list of all of the Amazon Quick Sight users belonging to this account.
This is a convenience which creates an instance of the
ListUsersRequest.Builderavoiding the need to create one manually viaListUsersRequest.builder()- Parameters:
listUsersRequest- AConsumerthat will call methods onListUsersRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUsersPaginator
This is a variant of
listUsers(software.amazon.awssdk.services.quicksight.model.ListUsersRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListUsersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListUsersResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.quicksight.model.ListUsersRequest)operation.- Parameters:
listUsersRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUsersPaginator
This is a variant of
listUsers(software.amazon.awssdk.services.quicksight.model.ListUsersRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListUsersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListUsersResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.quicksight.model.ListUsersRequest)operation.
This is a convenience which creates an instance of the
ListUsersRequest.Builderavoiding the need to create one manually viaListUsersRequest.builder()- Parameters:
listUsersRequest- AConsumerthat will call methods onListUsersRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVPCConnections
default CompletableFuture<ListVpcConnectionsResponse> listVPCConnections(ListVpcConnectionsRequest listVpcConnectionsRequest) Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
- Parameters:
listVpcConnectionsRequest-- Returns:
- A Java Future containing the result of the ListVPCConnections operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVPCConnections
default CompletableFuture<ListVpcConnectionsResponse> listVPCConnections(Consumer<ListVpcConnectionsRequest.Builder> listVpcConnectionsRequest) Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
This is a convenience which creates an instance of the
ListVpcConnectionsRequest.Builderavoiding the need to create one manually viaListVpcConnectionsRequest.builder()- Parameters:
listVpcConnectionsRequest- AConsumerthat will call methods onListVpcConnectionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListVPCConnections operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVPCConnectionsPaginator
default ListVPCConnectionsPublisher listVPCConnectionsPaginator(ListVpcConnectionsRequest listVpcConnectionsRequest) This is a variant of
listVPCConnections(software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListVPCConnectionsPublisher publisher = client.listVPCConnectionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListVPCConnectionsPublisher publisher = client.listVPCConnectionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVPCConnections(software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsRequest)operation.- Parameters:
listVpcConnectionsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVPCConnectionsPaginator
default ListVPCConnectionsPublisher listVPCConnectionsPaginator(Consumer<ListVpcConnectionsRequest.Builder> listVpcConnectionsRequest) This is a variant of
listVPCConnections(software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.ListVPCConnectionsPublisher publisher = client.listVPCConnectionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.ListVPCConnectionsPublisher publisher = client.listVPCConnectionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVPCConnections(software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsRequest)operation.
This is a convenience which creates an instance of the
ListVpcConnectionsRequest.Builderavoiding the need to create one manually viaListVpcConnectionsRequest.builder()- Parameters:
listVpcConnectionsRequest- AConsumerthat will call methods onListVpcConnectionsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
predictQAResults
default CompletableFuture<PredictQaResultsResponse> predictQAResults(PredictQaResultsRequest predictQaResultsRequest) Predicts existing visuals or generates new visuals to answer a given query.
This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for QuickSight with the scope value set to
quicksight:read. Before you use this action, make sure that you have configured the relevant QuickSight resource and permissions.We recommend enabling the
QSearchStatusAPI to unlock the full potential ofPredictQnA. WhenQSearchStatusis enabled, it first checks the specified dashboard for any existing visuals that match the question. If no matching visuals are found,PredictQnAuses generative Q&A to provide an answer. To update theQSearchStatus, see UpdateQuickSightQSearchConfiguration.- Parameters:
predictQaResultsRequest-- Returns:
- A Java Future containing the result of the PredictQAResults operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
predictQAResults
default CompletableFuture<PredictQaResultsResponse> predictQAResults(Consumer<PredictQaResultsRequest.Builder> predictQaResultsRequest) Predicts existing visuals or generates new visuals to answer a given query.
This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for QuickSight with the scope value set to
quicksight:read. Before you use this action, make sure that you have configured the relevant QuickSight resource and permissions.We recommend enabling the
QSearchStatusAPI to unlock the full potential ofPredictQnA. WhenQSearchStatusis enabled, it first checks the specified dashboard for any existing visuals that match the question. If no matching visuals are found,PredictQnAuses generative Q&A to provide an answer. To update theQSearchStatus, see UpdateQuickSightQSearchConfiguration.
This is a convenience which creates an instance of the
PredictQaResultsRequest.Builderavoiding the need to create one manually viaPredictQaResultsRequest.builder()- Parameters:
predictQaResultsRequest- AConsumerthat will call methods onPredictQaResultsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the PredictQAResults operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putDataSetRefreshProperties
default CompletableFuture<PutDataSetRefreshPropertiesResponse> putDataSetRefreshProperties(PutDataSetRefreshPropertiesRequest putDataSetRefreshPropertiesRequest) Creates or updates the dataset refresh properties for the dataset.
- Parameters:
putDataSetRefreshPropertiesRequest-- Returns:
- A Java Future containing the result of the PutDataSetRefreshProperties operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- PreconditionNotMetException One or more preconditions aren't met.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putDataSetRefreshProperties
default CompletableFuture<PutDataSetRefreshPropertiesResponse> putDataSetRefreshProperties(Consumer<PutDataSetRefreshPropertiesRequest.Builder> putDataSetRefreshPropertiesRequest) Creates or updates the dataset refresh properties for the dataset.
This is a convenience which creates an instance of the
PutDataSetRefreshPropertiesRequest.Builderavoiding the need to create one manually viaPutDataSetRefreshPropertiesRequest.builder()- Parameters:
putDataSetRefreshPropertiesRequest- AConsumerthat will call methods onPutDataSetRefreshPropertiesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the PutDataSetRefreshProperties operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- PreconditionNotMetException One or more preconditions aren't met.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerUser
default CompletableFuture<RegisterUserResponse> registerUser(RegisterUserRequest registerUserRequest) Creates an Amazon Quick Sight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Quick Sight API, Quick Sight generates a registration URL. The user accesses this registration URL to create their account. Quick Sight doesn't send a registration email to users who are registered from the Quick Sight API. If you want new users to receive a registration email, then add those users in the Quick Sight console. For more information on registering a new user in the Quick Sight console, see Inviting users to access Quick Sight.
- Parameters:
registerUserRequest-- Returns:
- A Java Future containing the result of the RegisterUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerUser
default CompletableFuture<RegisterUserResponse> registerUser(Consumer<RegisterUserRequest.Builder> registerUserRequest) Creates an Amazon Quick Sight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Quick Sight API, Quick Sight generates a registration URL. The user accesses this registration URL to create their account. Quick Sight doesn't send a registration email to users who are registered from the Quick Sight API. If you want new users to receive a registration email, then add those users in the Quick Sight console. For more information on registering a new user in the Quick Sight console, see Inviting users to access Quick Sight.
This is a convenience which creates an instance of the
RegisterUserRequest.Builderavoiding the need to create one manually viaRegisterUserRequest.builder()- Parameters:
registerUserRequest- AConsumerthat will call methods onRegisterUserRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the RegisterUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
restoreAnalysis
default CompletableFuture<RestoreAnalysisResponse> restoreAnalysis(RestoreAnalysisRequest restoreAnalysisRequest) Restores an analysis.
- Parameters:
restoreAnalysisRequest-- Returns:
- A Java Future containing the result of the RestoreAnalysis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- LimitExceededException A limit is exceeded.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
restoreAnalysis
default CompletableFuture<RestoreAnalysisResponse> restoreAnalysis(Consumer<RestoreAnalysisRequest.Builder> restoreAnalysisRequest) Restores an analysis.
This is a convenience which creates an instance of the
RestoreAnalysisRequest.Builderavoiding the need to create one manually viaRestoreAnalysisRequest.builder()- Parameters:
restoreAnalysisRequest- AConsumerthat will call methods onRestoreAnalysisRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the RestoreAnalysis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- LimitExceededException A limit is exceeded.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchActionConnectors
default CompletableFuture<SearchActionConnectorsResponse> searchActionConnectors(SearchActionConnectorsRequest searchActionConnectorsRequest) Searches for action connectors in the specified Amazon Web Services account using filters. You can search by connector name, type, or user permissions.
- Parameters:
searchActionConnectorsRequest-- Returns:
- A Java Future containing the result of the SearchActionConnectors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchActionConnectors
default CompletableFuture<SearchActionConnectorsResponse> searchActionConnectors(Consumer<SearchActionConnectorsRequest.Builder> searchActionConnectorsRequest) Searches for action connectors in the specified Amazon Web Services account using filters. You can search by connector name, type, or user permissions.
This is a convenience which creates an instance of the
SearchActionConnectorsRequest.Builderavoiding the need to create one manually viaSearchActionConnectorsRequest.builder()- Parameters:
searchActionConnectorsRequest- AConsumerthat will call methods onSearchActionConnectorsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the SearchActionConnectors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchActionConnectorsPaginator
default SearchActionConnectorsPublisher searchActionConnectorsPaginator(SearchActionConnectorsRequest searchActionConnectorsRequest) This is a variant of
searchActionConnectors(software.amazon.awssdk.services.quicksight.model.SearchActionConnectorsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.SearchActionConnectorsPublisher publisher = client.searchActionConnectorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.SearchActionConnectorsPublisher publisher = client.searchActionConnectorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchActionConnectorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchActionConnectorsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchActionConnectors(software.amazon.awssdk.services.quicksight.model.SearchActionConnectorsRequest)operation.- Parameters:
searchActionConnectorsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchActionConnectorsPaginator
default SearchActionConnectorsPublisher searchActionConnectorsPaginator(Consumer<SearchActionConnectorsRequest.Builder> searchActionConnectorsRequest) This is a variant of
searchActionConnectors(software.amazon.awssdk.services.quicksight.model.SearchActionConnectorsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.SearchActionConnectorsPublisher publisher = client.searchActionConnectorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.SearchActionConnectorsPublisher publisher = client.searchActionConnectorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchActionConnectorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchActionConnectorsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchActionConnectors(software.amazon.awssdk.services.quicksight.model.SearchActionConnectorsRequest)operation.
This is a convenience which creates an instance of the
SearchActionConnectorsRequest.Builderavoiding the need to create one manually viaSearchActionConnectorsRequest.builder()- Parameters:
searchActionConnectorsRequest- AConsumerthat will call methods onSearchActionConnectorsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchAnalyses
default CompletableFuture<SearchAnalysesResponse> searchAnalyses(SearchAnalysesRequest searchAnalysesRequest) Searches for analyses that belong to the user specified in the filter.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
- Parameters:
searchAnalysesRequest-- Returns:
- A Java Future containing the result of the SearchAnalyses operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchAnalyses
default CompletableFuture<SearchAnalysesResponse> searchAnalyses(Consumer<SearchAnalysesRequest.Builder> searchAnalysesRequest) Searches for analyses that belong to the user specified in the filter.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This is a convenience which creates an instance of the
SearchAnalysesRequest.Builderavoiding the need to create one manually viaSearchAnalysesRequest.builder()- Parameters:
searchAnalysesRequest- AConsumerthat will call methods onSearchAnalysesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the SearchAnalyses operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchAnalysesPaginator
default SearchAnalysesPublisher searchAnalysesPaginator(SearchAnalysesRequest searchAnalysesRequest) This is a variant of
searchAnalyses(software.amazon.awssdk.services.quicksight.model.SearchAnalysesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.SearchAnalysesPublisher publisher = client.searchAnalysesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.SearchAnalysesPublisher publisher = client.searchAnalysesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchAnalysesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchAnalysesResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchAnalyses(software.amazon.awssdk.services.quicksight.model.SearchAnalysesRequest)operation.- Parameters:
searchAnalysesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchAnalysesPaginator
default SearchAnalysesPublisher searchAnalysesPaginator(Consumer<SearchAnalysesRequest.Builder> searchAnalysesRequest) This is a variant of
searchAnalyses(software.amazon.awssdk.services.quicksight.model.SearchAnalysesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.SearchAnalysesPublisher publisher = client.searchAnalysesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.SearchAnalysesPublisher publisher = client.searchAnalysesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchAnalysesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchAnalysesResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchAnalyses(software.amazon.awssdk.services.quicksight.model.SearchAnalysesRequest)operation.
This is a convenience which creates an instance of the
SearchAnalysesRequest.Builderavoiding the need to create one manually viaSearchAnalysesRequest.builder()- Parameters:
searchAnalysesRequest- AConsumerthat will call methods onSearchAnalysesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchDashboards
default CompletableFuture<SearchDashboardsResponse> searchDashboards(SearchDashboardsRequest searchDashboardsRequest) Searches for dashboards that belong to a user.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
- Parameters:
searchDashboardsRequest-- Returns:
- A Java Future containing the result of the SearchDashboards operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchDashboards
default CompletableFuture<SearchDashboardsResponse> searchDashboards(Consumer<SearchDashboardsRequest.Builder> searchDashboardsRequest) Searches for dashboards that belong to a user.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This is a convenience which creates an instance of the
SearchDashboardsRequest.Builderavoiding the need to create one manually viaSearchDashboardsRequest.builder()- Parameters:
searchDashboardsRequest- AConsumerthat will call methods onSearchDashboardsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the SearchDashboards operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchDashboardsPaginator
default SearchDashboardsPublisher searchDashboardsPaginator(SearchDashboardsRequest searchDashboardsRequest) This is a variant of
searchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.SearchDashboardsPublisher publisher = client.searchDashboardsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsPublisher publisher = client.searchDashboardsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchDashboardsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchDashboardsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest)operation.- Parameters:
searchDashboardsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchDashboardsPaginator
default SearchDashboardsPublisher searchDashboardsPaginator(Consumer<SearchDashboardsRequest.Builder> searchDashboardsRequest) This is a variant of
searchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.SearchDashboardsPublisher publisher = client.searchDashboardsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsPublisher publisher = client.searchDashboardsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchDashboardsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchDashboardsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest)operation.
This is a convenience which creates an instance of the
SearchDashboardsRequest.Builderavoiding the need to create one manually viaSearchDashboardsRequest.builder()- Parameters:
searchDashboardsRequest- AConsumerthat will call methods onSearchDashboardsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchDataSets
default CompletableFuture<SearchDataSetsResponse> searchDataSets(SearchDataSetsRequest searchDataSetsRequest) Use the
SearchDataSetsoperation to search for datasets that belong to an account.- Parameters:
searchDataSetsRequest-- Returns:
- A Java Future containing the result of the SearchDataSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchDataSets
default CompletableFuture<SearchDataSetsResponse> searchDataSets(Consumer<SearchDataSetsRequest.Builder> searchDataSetsRequest) Use the
SearchDataSetsoperation to search for datasets that belong to an account.
This is a convenience which creates an instance of the
SearchDataSetsRequest.Builderavoiding the need to create one manually viaSearchDataSetsRequest.builder()- Parameters:
searchDataSetsRequest- AConsumerthat will call methods onSearchDataSetsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the SearchDataSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchDataSetsPaginator
default SearchDataSetsPublisher searchDataSetsPaginator(SearchDataSetsRequest searchDataSetsRequest) This is a variant of
searchDataSets(software.amazon.awssdk.services.quicksight.model.SearchDataSetsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.SearchDataSetsPublisher publisher = client.searchDataSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.SearchDataSetsPublisher publisher = client.searchDataSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchDataSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchDataSetsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDataSets(software.amazon.awssdk.services.quicksight.model.SearchDataSetsRequest)operation.- Parameters:
searchDataSetsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchDataSetsPaginator
default SearchDataSetsPublisher searchDataSetsPaginator(Consumer<SearchDataSetsRequest.Builder> searchDataSetsRequest) This is a variant of
searchDataSets(software.amazon.awssdk.services.quicksight.model.SearchDataSetsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.SearchDataSetsPublisher publisher = client.searchDataSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.SearchDataSetsPublisher publisher = client.searchDataSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchDataSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchDataSetsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDataSets(software.amazon.awssdk.services.quicksight.model.SearchDataSetsRequest)operation.
This is a convenience which creates an instance of the
SearchDataSetsRequest.Builderavoiding the need to create one manually viaSearchDataSetsRequest.builder()- Parameters:
searchDataSetsRequest- AConsumerthat will call methods onSearchDataSetsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchDataSources
default CompletableFuture<SearchDataSourcesResponse> searchDataSources(SearchDataSourcesRequest searchDataSourcesRequest) Use the
SearchDataSourcesoperation to search for data sources that belong to an account.- Parameters:
searchDataSourcesRequest-- Returns:
- A Java Future containing the result of the SearchDataSources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchDataSources
default CompletableFuture<SearchDataSourcesResponse> searchDataSources(Consumer<SearchDataSourcesRequest.Builder> searchDataSourcesRequest) Use the
SearchDataSourcesoperation to search for data sources that belong to an account.
This is a convenience which creates an instance of the
SearchDataSourcesRequest.Builderavoiding the need to create one manually viaSearchDataSourcesRequest.builder()- Parameters:
searchDataSourcesRequest- AConsumerthat will call methods onSearchDataSourcesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the SearchDataSources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchDataSourcesPaginator
default SearchDataSourcesPublisher searchDataSourcesPaginator(SearchDataSourcesRequest searchDataSourcesRequest) This is a variant of
searchDataSources(software.amazon.awssdk.services.quicksight.model.SearchDataSourcesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.SearchDataSourcesPublisher publisher = client.searchDataSourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.SearchDataSourcesPublisher publisher = client.searchDataSourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchDataSourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchDataSourcesResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDataSources(software.amazon.awssdk.services.quicksight.model.SearchDataSourcesRequest)operation.- Parameters:
searchDataSourcesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchDataSourcesPaginator
default SearchDataSourcesPublisher searchDataSourcesPaginator(Consumer<SearchDataSourcesRequest.Builder> searchDataSourcesRequest) This is a variant of
searchDataSources(software.amazon.awssdk.services.quicksight.model.SearchDataSourcesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.SearchDataSourcesPublisher publisher = client.searchDataSourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.SearchDataSourcesPublisher publisher = client.searchDataSourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchDataSourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchDataSourcesResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDataSources(software.amazon.awssdk.services.quicksight.model.SearchDataSourcesRequest)operation.
This is a convenience which creates an instance of the
SearchDataSourcesRequest.Builderavoiding the need to create one manually viaSearchDataSourcesRequest.builder()- Parameters:
searchDataSourcesRequest- AConsumerthat will call methods onSearchDataSourcesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchFlows
Search for the flows in an Amazon Web Services account.
- Parameters:
searchFlowsRequest-- Returns:
- A Java Future containing the result of the SearchFlows operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchFlows
default CompletableFuture<SearchFlowsResponse> searchFlows(Consumer<SearchFlowsRequest.Builder> searchFlowsRequest) Search for the flows in an Amazon Web Services account.
This is a convenience which creates an instance of the
SearchFlowsRequest.Builderavoiding the need to create one manually viaSearchFlowsRequest.builder()- Parameters:
searchFlowsRequest- AConsumerthat will call methods onSearchFlowsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the SearchFlows operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchFlowsPaginator
This is a variant of
searchFlows(software.amazon.awssdk.services.quicksight.model.SearchFlowsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.SearchFlowsPublisher publisher = client.searchFlowsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.SearchFlowsPublisher publisher = client.searchFlowsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchFlowsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchFlowsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchFlows(software.amazon.awssdk.services.quicksight.model.SearchFlowsRequest)operation.- Parameters:
searchFlowsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchFlowsPaginator
default SearchFlowsPublisher searchFlowsPaginator(Consumer<SearchFlowsRequest.Builder> searchFlowsRequest) This is a variant of
searchFlows(software.amazon.awssdk.services.quicksight.model.SearchFlowsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.SearchFlowsPublisher publisher = client.searchFlowsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.SearchFlowsPublisher publisher = client.searchFlowsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchFlowsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchFlowsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchFlows(software.amazon.awssdk.services.quicksight.model.SearchFlowsRequest)operation.
This is a convenience which creates an instance of the
SearchFlowsRequest.Builderavoiding the need to create one manually viaSearchFlowsRequest.builder()- Parameters:
searchFlowsRequest- AConsumerthat will call methods onSearchFlowsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchFolders
default CompletableFuture<SearchFoldersResponse> searchFolders(SearchFoldersRequest searchFoldersRequest) Searches the subfolders in a folder.
- Parameters:
searchFoldersRequest-- Returns:
- A Java Future containing the result of the SearchFolders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchFolders
default CompletableFuture<SearchFoldersResponse> searchFolders(Consumer<SearchFoldersRequest.Builder> searchFoldersRequest) Searches the subfolders in a folder.
This is a convenience which creates an instance of the
SearchFoldersRequest.Builderavoiding the need to create one manually viaSearchFoldersRequest.builder()- Parameters:
searchFoldersRequest- AConsumerthat will call methods onSearchFoldersRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the SearchFolders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchFoldersPaginator
This is a variant of
searchFolders(software.amazon.awssdk.services.quicksight.model.SearchFoldersRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.SearchFoldersPublisher publisher = client.searchFoldersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.SearchFoldersPublisher publisher = client.searchFoldersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchFoldersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchFoldersResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchFolders(software.amazon.awssdk.services.quicksight.model.SearchFoldersRequest)operation.- Parameters:
searchFoldersRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchFoldersPaginator
default SearchFoldersPublisher searchFoldersPaginator(Consumer<SearchFoldersRequest.Builder> searchFoldersRequest) This is a variant of
searchFolders(software.amazon.awssdk.services.quicksight.model.SearchFoldersRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.SearchFoldersPublisher publisher = client.searchFoldersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.SearchFoldersPublisher publisher = client.searchFoldersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchFoldersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchFoldersResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchFolders(software.amazon.awssdk.services.quicksight.model.SearchFoldersRequest)operation.
This is a convenience which creates an instance of the
SearchFoldersRequest.Builderavoiding the need to create one manually viaSearchFoldersRequest.builder()- Parameters:
searchFoldersRequest- AConsumerthat will call methods onSearchFoldersRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchGroups
default CompletableFuture<SearchGroupsResponse> searchGroups(SearchGroupsRequest searchGroupsRequest) Use the
SearchGroupsoperation to search groups in a specified Quick Sight namespace using the supplied filters.- Parameters:
searchGroupsRequest-- Returns:
- A Java Future containing the result of the SearchGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchGroups
default CompletableFuture<SearchGroupsResponse> searchGroups(Consumer<SearchGroupsRequest.Builder> searchGroupsRequest) Use the
SearchGroupsoperation to search groups in a specified Quick Sight namespace using the supplied filters.
This is a convenience which creates an instance of the
SearchGroupsRequest.Builderavoiding the need to create one manually viaSearchGroupsRequest.builder()- Parameters:
searchGroupsRequest- AConsumerthat will call methods onSearchGroupsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the SearchGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchGroupsPaginator
This is a variant of
searchGroups(software.amazon.awssdk.services.quicksight.model.SearchGroupsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.SearchGroupsPublisher publisher = client.searchGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.SearchGroupsPublisher publisher = client.searchGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchGroupsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchGroups(software.amazon.awssdk.services.quicksight.model.SearchGroupsRequest)operation.- Parameters:
searchGroupsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchGroupsPaginator
default SearchGroupsPublisher searchGroupsPaginator(Consumer<SearchGroupsRequest.Builder> searchGroupsRequest) This is a variant of
searchGroups(software.amazon.awssdk.services.quicksight.model.SearchGroupsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.SearchGroupsPublisher publisher = client.searchGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.SearchGroupsPublisher publisher = client.searchGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchGroupsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchGroups(software.amazon.awssdk.services.quicksight.model.SearchGroupsRequest)operation.
This is a convenience which creates an instance of the
SearchGroupsRequest.Builderavoiding the need to create one manually viaSearchGroupsRequest.builder()- Parameters:
searchGroupsRequest- AConsumerthat will call methods onSearchGroupsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchTopics
default CompletableFuture<SearchTopicsResponse> searchTopics(SearchTopicsRequest searchTopicsRequest) Searches for any Q topic that exists in an QuickSight account.
- Parameters:
searchTopicsRequest-- Returns:
- A Java Future containing the result of the SearchTopics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchTopics
default CompletableFuture<SearchTopicsResponse> searchTopics(Consumer<SearchTopicsRequest.Builder> searchTopicsRequest) Searches for any Q topic that exists in an QuickSight account.
This is a convenience which creates an instance of the
SearchTopicsRequest.Builderavoiding the need to create one manually viaSearchTopicsRequest.builder()- Parameters:
searchTopicsRequest- AConsumerthat will call methods onSearchTopicsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the SearchTopics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchTopicsPaginator
This is a variant of
searchTopics(software.amazon.awssdk.services.quicksight.model.SearchTopicsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.SearchTopicsPublisher publisher = client.searchTopicsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.SearchTopicsPublisher publisher = client.searchTopicsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchTopicsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchTopicsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchTopics(software.amazon.awssdk.services.quicksight.model.SearchTopicsRequest)operation.- Parameters:
searchTopicsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchTopicsPaginator
default SearchTopicsPublisher searchTopicsPaginator(Consumer<SearchTopicsRequest.Builder> searchTopicsRequest) This is a variant of
searchTopics(software.amazon.awssdk.services.quicksight.model.SearchTopicsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.quicksight.paginators.SearchTopicsPublisher publisher = client.searchTopicsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.quicksight.paginators.SearchTopicsPublisher publisher = client.searchTopicsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchTopicsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchTopicsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchTopics(software.amazon.awssdk.services.quicksight.model.SearchTopicsRequest)operation.
This is a convenience which creates an instance of the
SearchTopicsRequest.Builderavoiding the need to create one manually viaSearchTopicsRequest.builder()- Parameters:
searchTopicsRequest- AConsumerthat will call methods onSearchTopicsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidNextTokenException The
NextTokenvalue isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startAssetBundleExportJob
default CompletableFuture<StartAssetBundleExportJobResponse> startAssetBundleExportJob(StartAssetBundleExportJobRequest startAssetBundleExportJobRequest) Starts an Asset Bundle export job.
An Asset Bundle export job exports specified Amazon Quick Sight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a
DescribeAssetBundleExportJobAPI call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with aDescribeAssetBundleExportJobAPI call. Each Amazon Quick Sight account can run up to 5 export jobs concurrently.The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
- Parameters:
startAssetBundleExportJobRequest-- Returns:
- A Java Future containing the result of the StartAssetBundleExportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- LimitExceededException A limit is exceeded.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startAssetBundleExportJob
default CompletableFuture<StartAssetBundleExportJobResponse> startAssetBundleExportJob(Consumer<StartAssetBundleExportJobRequest.Builder> startAssetBundleExportJobRequest) Starts an Asset Bundle export job.
An Asset Bundle export job exports specified Amazon Quick Sight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a
DescribeAssetBundleExportJobAPI call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with aDescribeAssetBundleExportJobAPI call. Each Amazon Quick Sight account can run up to 5 export jobs concurrently.The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
This is a convenience which creates an instance of the
StartAssetBundleExportJobRequest.Builderavoiding the need to create one manually viaStartAssetBundleExportJobRequest.builder()- Parameters:
startAssetBundleExportJobRequest- AConsumerthat will call methods onStartAssetBundleExportJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartAssetBundleExportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- LimitExceededException A limit is exceeded.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startAssetBundleImportJob
default CompletableFuture<StartAssetBundleImportJobResponse> startAssetBundleImportJob(StartAssetBundleImportJobRequest startAssetBundleImportJobRequest) Starts an Asset Bundle import job.
An Asset Bundle import job imports specified Amazon Quick Sight assets into an Amazon Quick Sight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon Quick Sight account. Each Amazon Quick Sight account can run up to 5 import jobs concurrently.
The API caller must have the necessary
"create","describe", and"update"permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.- Parameters:
startAssetBundleImportJobRequest-- Returns:
- A Java Future containing the result of the StartAssetBundleImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- LimitExceededException A limit is exceeded.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startAssetBundleImportJob
default CompletableFuture<StartAssetBundleImportJobResponse> startAssetBundleImportJob(Consumer<StartAssetBundleImportJobRequest.Builder> startAssetBundleImportJobRequest) Starts an Asset Bundle import job.
An Asset Bundle import job imports specified Amazon Quick Sight assets into an Amazon Quick Sight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon Quick Sight account. Each Amazon Quick Sight account can run up to 5 import jobs concurrently.
The API caller must have the necessary
"create","describe", and"update"permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.
This is a convenience which creates an instance of the
StartAssetBundleImportJobRequest.Builderavoiding the need to create one manually viaStartAssetBundleImportJobRequest.builder()- Parameters:
startAssetBundleImportJobRequest- AConsumerthat will call methods onStartAssetBundleImportJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartAssetBundleImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- LimitExceededException A limit is exceeded.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startDashboardSnapshotJob
default CompletableFuture<StartDashboardSnapshotJobResponse> startDashboardSnapshotJob(StartDashboardSnapshotJobRequest startDashboardSnapshotJobRequest) Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.
-
1 Paginated PDF
-
1 Excel workbook that includes up to 5 table or pivot table visuals
-
5 CSVs from table or pivot table visuals
The status of a submitted job can be polled with the
DescribeDashboardSnapshotJobAPI. When you call theDescribeDashboardSnapshotJobAPI, check theJobStatusfield in the response. Once the job reaches aCOMPLETEDorFAILEDstatus, use theDescribeDashboardSnapshotJobResultAPI to obtain the URLs for the generated files. If the job fails, theDescribeDashboardSnapshotJobResultAPI returns detailed information about the error that occurred.StartDashboardSnapshotJob API throttling
Quick Sight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the
StartDashboardSnapshotJob. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Quick Sight throttles the API calls to maintin an optimal experience and reliability for all Quick Sight users.Common throttling scenarios
The following list provides information about the most commin throttling scenarios that can occur.
-
A large number of
SnapshotExportAPI jobs are running simultaneously on an Amazon Web Services account. When a newStartDashboardSnapshotJobis created and there are already 12 jobs with theRUNNINGstatus, the new job request fails and returns aLimitExceededExceptionerror. Wait for a current job to comlpete before you resubmit the new job. -
A large number of API requests are submitted on an Amazon Web Services account. When a user makes more than 10 API calls to the Quick Sight API in one second, a
ThrottlingExceptionis returned.
If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account.
Best practices to handle throttling
If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Quick Sight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example
(12 minutes * 9 = 108 minutes). Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline.The time that it takes to process a job can be impacted by the following factors:
-
The dataset type (Direct Query or SPICE).
-
The size of the dataset.
-
The complexity of the calculated fields that are used in the dashboard.
-
The number of visuals that are on a sheet.
-
The types of visuals that are on the sheet.
-
The number of formats and snapshots that are requested in the job configuration.
-
The size of the generated snapshots.
- Parameters:
startDashboardSnapshotJobRequest-- Returns:
- A Java Future containing the result of the StartDashboardSnapshotJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- UnsupportedPricingPlanException This error indicates that you are calling an embedding operation in
Amazon Quick Sight without the required pricing plan on your Amazon Web Services account. Before you can
use embedding for anonymous users, a Quick Suite administrator needs to add capacity pricing to Quick
Sight. You can do this on the Manage Quick Suite page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrlAPI operation with the--identity-type ANONYMOUSoption. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
startDashboardSnapshotJob
default CompletableFuture<StartDashboardSnapshotJobResponse> startDashboardSnapshotJob(Consumer<StartDashboardSnapshotJobRequest.Builder> startDashboardSnapshotJobRequest) Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.
-
1 Paginated PDF
-
1 Excel workbook that includes up to 5 table or pivot table visuals
-
5 CSVs from table or pivot table visuals
The status of a submitted job can be polled with the
DescribeDashboardSnapshotJobAPI. When you call theDescribeDashboardSnapshotJobAPI, check theJobStatusfield in the response. Once the job reaches aCOMPLETEDorFAILEDstatus, use theDescribeDashboardSnapshotJobResultAPI to obtain the URLs for the generated files. If the job fails, theDescribeDashboardSnapshotJobResultAPI returns detailed information about the error that occurred.StartDashboardSnapshotJob API throttling
Quick Sight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the
StartDashboardSnapshotJob. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Quick Sight throttles the API calls to maintin an optimal experience and reliability for all Quick Sight users.Common throttling scenarios
The following list provides information about the most commin throttling scenarios that can occur.
-
A large number of
SnapshotExportAPI jobs are running simultaneously on an Amazon Web Services account. When a newStartDashboardSnapshotJobis created and there are already 12 jobs with theRUNNINGstatus, the new job request fails and returns aLimitExceededExceptionerror. Wait for a current job to comlpete before you resubmit the new job. -
A large number of API requests are submitted on an Amazon Web Services account. When a user makes more than 10 API calls to the Quick Sight API in one second, a
ThrottlingExceptionis returned.
If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account.
Best practices to handle throttling
If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Quick Sight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example
(12 minutes * 9 = 108 minutes). Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline.The time that it takes to process a job can be impacted by the following factors:
-
The dataset type (Direct Query or SPICE).
-
The size of the dataset.
-
The complexity of the calculated fields that are used in the dashboard.
-
The number of visuals that are on a sheet.
-
The types of visuals that are on the sheet.
-
The number of formats and snapshots that are requested in the job configuration.
-
The size of the generated snapshots.
This is a convenience which creates an instance of the
StartDashboardSnapshotJobRequest.Builderavoiding the need to create one manually viaStartDashboardSnapshotJobRequest.builder()- Parameters:
startDashboardSnapshotJobRequest- AConsumerthat will call methods onStartDashboardSnapshotJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartDashboardSnapshotJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- UnsupportedPricingPlanException This error indicates that you are calling an embedding operation in
Amazon Quick Sight without the required pricing plan on your Amazon Web Services account. Before you can
use embedding for anonymous users, a Quick Suite administrator needs to add capacity pricing to Quick
Sight. You can do this on the Manage Quick Suite page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrlAPI operation with the--identity-type ANONYMOUSoption. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
startDashboardSnapshotJobSchedule
default CompletableFuture<StartDashboardSnapshotJobScheduleResponse> startDashboardSnapshotJobSchedule(StartDashboardSnapshotJobScheduleRequest startDashboardSnapshotJobScheduleRequest) Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.
Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a
202HTTP status code.For more information, see Scheduling and sending Amazon Quick Sight reports by email and Configuring email report settings for a Amazon Quick Sight dashboard in the Amazon Quick Sight User Guide.
- Parameters:
startDashboardSnapshotJobScheduleRequest-- Returns:
- A Java Future containing the result of the StartDashboardSnapshotJobSchedule operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startDashboardSnapshotJobSchedule
default CompletableFuture<StartDashboardSnapshotJobScheduleResponse> startDashboardSnapshotJobSchedule(Consumer<StartDashboardSnapshotJobScheduleRequest.Builder> startDashboardSnapshotJobScheduleRequest) Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.
Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a
202HTTP status code.For more information, see Scheduling and sending Amazon Quick Sight reports by email and Configuring email report settings for a Amazon Quick Sight dashboard in the Amazon Quick Sight User Guide.
This is a convenience which creates an instance of the
StartDashboardSnapshotJobScheduleRequest.Builderavoiding the need to create one manually viaStartDashboardSnapshotJobScheduleRequest.builder()- Parameters:
startDashboardSnapshotJobScheduleRequest- AConsumerthat will call methods onStartDashboardSnapshotJobScheduleRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartDashboardSnapshotJobSchedule operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Assigns one or more tags (key-value pairs) to the specified Amazon Quick Sight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the
TagResourceoperation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.You can associate as many as 50 tags with a resource. Amazon Quick Sight supports tagging on data set, data source, dashboard, template, topic, and user.
Tagging for Amazon Quick Sight works in a similar way to tagging for other Amazon Web Services services, except for the following:
-
Tags are used to track costs for users in Amazon Quick Sight. You can't tag other resources that Amazon Quick Sight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units.
-
Amazon Quick Sight doesn't currently support the tag editor for Resource Groups.
- Parameters:
tagResourceRequest-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- LimitExceededException A limit is exceeded.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Assigns one or more tags (key-value pairs) to the specified Amazon Quick Sight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the
TagResourceoperation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.You can associate as many as 50 tags with a resource. Amazon Quick Sight supports tagging on data set, data source, dashboard, template, topic, and user.
Tagging for Amazon Quick Sight works in a similar way to tagging for other Amazon Web Services services, except for the following:
-
Tags are used to track costs for users in Amazon Quick Sight. You can't tag other resources that Amazon Quick Sight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units.
-
Amazon Quick Sight doesn't currently support the tag editor for Resource Groups.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- LimitExceededException A limit is exceeded.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes a tag or tags from a resource.
- Parameters:
untagResourceRequest-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes a tag or tags from a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAccountCustomPermission
default CompletableFuture<UpdateAccountCustomPermissionResponse> updateAccountCustomPermission(UpdateAccountCustomPermissionRequest updateAccountCustomPermissionRequest) Applies a custom permissions profile to an account.
- Parameters:
updateAccountCustomPermissionRequest-- Returns:
- A Java Future containing the result of the UpdateAccountCustomPermission operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAccountCustomPermission
default CompletableFuture<UpdateAccountCustomPermissionResponse> updateAccountCustomPermission(Consumer<UpdateAccountCustomPermissionRequest.Builder> updateAccountCustomPermissionRequest) Applies a custom permissions profile to an account.
This is a convenience which creates an instance of the
UpdateAccountCustomPermissionRequest.Builderavoiding the need to create one manually viaUpdateAccountCustomPermissionRequest.builder()- Parameters:
updateAccountCustomPermissionRequest- AConsumerthat will call methods onUpdateAccountCustomPermissionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateAccountCustomPermission operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAccountCustomization
default CompletableFuture<UpdateAccountCustomizationResponse> updateAccountCustomization(UpdateAccountCustomizationRequest updateAccountCustomizationRequest) Updates Amazon Quick Sight customizations. Currently, the only customization that you can use is a theme.
You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Quick Sight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the
DescribeAccountCustomizationAPI operation.- Parameters:
updateAccountCustomizationRequest-- Returns:
- A Java Future containing the result of the UpdateAccountCustomization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAccountCustomization
default CompletableFuture<UpdateAccountCustomizationResponse> updateAccountCustomization(Consumer<UpdateAccountCustomizationRequest.Builder> updateAccountCustomizationRequest) Updates Amazon Quick Sight customizations. Currently, the only customization that you can use is a theme.
You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Quick Sight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the
DescribeAccountCustomizationAPI operation.
This is a convenience which creates an instance of the
UpdateAccountCustomizationRequest.Builderavoiding the need to create one manually viaUpdateAccountCustomizationRequest.builder()- Parameters:
updateAccountCustomizationRequest- AConsumerthat will call methods onUpdateAccountCustomizationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateAccountCustomization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAccountSettings
default CompletableFuture<UpdateAccountSettingsResponse> updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest) Updates the Amazon Quick Sight settings in your Amazon Web Services account.
- Parameters:
updateAccountSettingsRequest-- Returns:
- A Java Future containing the result of the UpdateAccountSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAccountSettings
default CompletableFuture<UpdateAccountSettingsResponse> updateAccountSettings(Consumer<UpdateAccountSettingsRequest.Builder> updateAccountSettingsRequest) Updates the Amazon Quick Sight settings in your Amazon Web Services account.
This is a convenience which creates an instance of the
UpdateAccountSettingsRequest.Builderavoiding the need to create one manually viaUpdateAccountSettingsRequest.builder()- Parameters:
updateAccountSettingsRequest- AConsumerthat will call methods onUpdateAccountSettingsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateAccountSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateActionConnector
default CompletableFuture<UpdateActionConnectorResponse> updateActionConnector(UpdateActionConnectorRequest updateActionConnectorRequest) Updates an existing action connector with new configuration details, authentication settings, or enabled actions. You can modify the connector's name, description, authentication configuration, and which actions are enabled. For more information, https ://docs.aws.amazon.com/quicksuite/latest/userguide/quick-action-auth.html.
- Parameters:
updateActionConnectorRequest-- Returns:
- A Java Future containing the result of the UpdateActionConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- ResourceNotFoundException One or more resources can't be found.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateActionConnector
default CompletableFuture<UpdateActionConnectorResponse> updateActionConnector(Consumer<UpdateActionConnectorRequest.Builder> updateActionConnectorRequest) Updates an existing action connector with new configuration details, authentication settings, or enabled actions. You can modify the connector's name, description, authentication configuration, and which actions are enabled. For more information, https ://docs.aws.amazon.com/quicksuite/latest/userguide/quick-action-auth.html.
This is a convenience which creates an instance of the
UpdateActionConnectorRequest.Builderavoiding the need to create one manually viaUpdateActionConnectorRequest.builder()- Parameters:
updateActionConnectorRequest- AConsumerthat will call methods onUpdateActionConnectorRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateActionConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- ResourceNotFoundException One or more resources can't be found.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateActionConnectorPermissions
default CompletableFuture<UpdateActionConnectorPermissionsResponse> updateActionConnectorPermissions(UpdateActionConnectorPermissionsRequest updateActionConnectorPermissionsRequest) Updates the permissions for an action connector by granting or revoking access for specific users and groups. You can control who can view, use, or manage the action connector.
- Parameters:
updateActionConnectorPermissionsRequest-- Returns:
- A Java Future containing the result of the UpdateActionConnectorPermissions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- LimitExceededException A limit is exceeded.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateActionConnectorPermissions
default CompletableFuture<UpdateActionConnectorPermissionsResponse> updateActionConnectorPermissions(Consumer<UpdateActionConnectorPermissionsRequest.Builder> updateActionConnectorPermissionsRequest) Updates the permissions for an action connector by granting or revoking access for specific users and groups. You can control who can view, use, or manage the action connector.
This is a convenience which creates an instance of the
UpdateActionConnectorPermissionsRequest.Builderavoiding the need to create one manually viaUpdateActionConnectorPermissionsRequest.builder()- Parameters:
updateActionConnectorPermissionsRequest- AConsumerthat will call methods onUpdateActionConnectorPermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateActionConnectorPermissions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- LimitExceededException A limit is exceeded.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAnalysis
default CompletableFuture<UpdateAnalysisResponse> updateAnalysis(UpdateAnalysisRequest updateAnalysisRequest) Updates an analysis in Amazon Quick Sight
- Parameters:
updateAnalysisRequest-- Returns:
- A Java Future containing the result of the UpdateAnalysis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAnalysis
default CompletableFuture<UpdateAnalysisResponse> updateAnalysis(Consumer<UpdateAnalysisRequest.Builder> updateAnalysisRequest) Updates an analysis in Amazon Quick Sight
This is a convenience which creates an instance of the
UpdateAnalysisRequest.Builderavoiding the need to create one manually viaUpdateAnalysisRequest.builder()- Parameters:
updateAnalysisRequest- AConsumerthat will call methods onUpdateAnalysisRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateAnalysis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAnalysisPermissions
default CompletableFuture<UpdateAnalysisPermissionsResponse> updateAnalysisPermissions(UpdateAnalysisPermissionsRequest updateAnalysisPermissionsRequest) Updates the read and write permissions for an analysis.
- Parameters:
updateAnalysisPermissionsRequest-- Returns:
- A Java Future containing the result of the UpdateAnalysisPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAnalysisPermissions
default CompletableFuture<UpdateAnalysisPermissionsResponse> updateAnalysisPermissions(Consumer<UpdateAnalysisPermissionsRequest.Builder> updateAnalysisPermissionsRequest) Updates the read and write permissions for an analysis.
This is a convenience which creates an instance of the
UpdateAnalysisPermissionsRequest.Builderavoiding the need to create one manually viaUpdateAnalysisPermissionsRequest.builder()- Parameters:
updateAnalysisPermissionsRequest- AConsumerthat will call methods onUpdateAnalysisPermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateAnalysisPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateApplicationWithTokenExchangeGrant
default CompletableFuture<UpdateApplicationWithTokenExchangeGrantResponse> updateApplicationWithTokenExchangeGrant(UpdateApplicationWithTokenExchangeGrantRequest updateApplicationWithTokenExchangeGrantRequest) Updates an QuickSight application with a token exchange grant. This operation only supports QuickSight applications that are registered with IAM Identity Center.
- Parameters:
updateApplicationWithTokenExchangeGrantRequest-- Returns:
- A Java Future containing the result of the UpdateApplicationWithTokenExchangeGrant operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- ResourceNotFoundException One or more resources can't be found.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateApplicationWithTokenExchangeGrant
default CompletableFuture<UpdateApplicationWithTokenExchangeGrantResponse> updateApplicationWithTokenExchangeGrant(Consumer<UpdateApplicationWithTokenExchangeGrantRequest.Builder> updateApplicationWithTokenExchangeGrantRequest) Updates an QuickSight application with a token exchange grant. This operation only supports QuickSight applications that are registered with IAM Identity Center.
This is a convenience which creates an instance of the
UpdateApplicationWithTokenExchangeGrantRequest.Builderavoiding the need to create one manually viaUpdateApplicationWithTokenExchangeGrantRequest.builder()- Parameters:
updateApplicationWithTokenExchangeGrantRequest- AConsumerthat will call methods onUpdateApplicationWithTokenExchangeGrantRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateApplicationWithTokenExchangeGrant operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- ResourceNotFoundException One or more resources can't be found.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateBrand
Updates a brand.
- Parameters:
updateBrandRequest-- Returns:
- A Java Future containing the result of the UpdateBrand operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InternalServerException An internal service exception.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateBrand
default CompletableFuture<UpdateBrandResponse> updateBrand(Consumer<UpdateBrandRequest.Builder> updateBrandRequest) Updates a brand.
This is a convenience which creates an instance of the
UpdateBrandRequest.Builderavoiding the need to create one manually viaUpdateBrandRequest.builder()- Parameters:
updateBrandRequest- AConsumerthat will call methods onUpdateBrandRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateBrand operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InternalServerException An internal service exception.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateBrandAssignment
default CompletableFuture<UpdateBrandAssignmentResponse> updateBrandAssignment(UpdateBrandAssignmentRequest updateBrandAssignmentRequest) Updates a brand assignment.
- Parameters:
updateBrandAssignmentRequest-- Returns:
- A Java Future containing the result of the UpdateBrandAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InternalServerException An internal service exception.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateBrandAssignment
default CompletableFuture<UpdateBrandAssignmentResponse> updateBrandAssignment(Consumer<UpdateBrandAssignmentRequest.Builder> updateBrandAssignmentRequest) Updates a brand assignment.
This is a convenience which creates an instance of the
UpdateBrandAssignmentRequest.Builderavoiding the need to create one manually viaUpdateBrandAssignmentRequest.builder()- Parameters:
updateBrandAssignmentRequest- AConsumerthat will call methods onUpdateBrandAssignmentRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateBrandAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InternalServerException An internal service exception.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateBrandPublishedVersion
default CompletableFuture<UpdateBrandPublishedVersionResponse> updateBrandPublishedVersion(UpdateBrandPublishedVersionRequest updateBrandPublishedVersionRequest) Updates the published version of a brand.
- Parameters:
updateBrandPublishedVersionRequest-- Returns:
- A Java Future containing the result of the UpdateBrandPublishedVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InternalServerException An internal service exception.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateBrandPublishedVersion
default CompletableFuture<UpdateBrandPublishedVersionResponse> updateBrandPublishedVersion(Consumer<UpdateBrandPublishedVersionRequest.Builder> updateBrandPublishedVersionRequest) Updates the published version of a brand.
This is a convenience which creates an instance of the
UpdateBrandPublishedVersionRequest.Builderavoiding the need to create one manually viaUpdateBrandPublishedVersionRequest.builder()- Parameters:
updateBrandPublishedVersionRequest- AConsumerthat will call methods onUpdateBrandPublishedVersionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateBrandPublishedVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InternalServerException An internal service exception.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCustomPermissions
default CompletableFuture<UpdateCustomPermissionsResponse> updateCustomPermissions(UpdateCustomPermissionsRequest updateCustomPermissionsRequest) Updates a custom permissions profile.
- Parameters:
updateCustomPermissionsRequest-- Returns:
- A Java Future containing the result of the UpdateCustomPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCustomPermissions
default CompletableFuture<UpdateCustomPermissionsResponse> updateCustomPermissions(Consumer<UpdateCustomPermissionsRequest.Builder> updateCustomPermissionsRequest) Updates a custom permissions profile.
This is a convenience which creates an instance of the
UpdateCustomPermissionsRequest.Builderavoiding the need to create one manually viaUpdateCustomPermissionsRequest.builder()- Parameters:
updateCustomPermissionsRequest- AConsumerthat will call methods onUpdateCustomPermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateCustomPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDashboard
default CompletableFuture<UpdateDashboardResponse> updateDashboard(UpdateDashboardRequest updateDashboardRequest) Updates a dashboard in an Amazon Web Services account.
Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the
UpdateDashboardPublishedVersionAPI operation.- Parameters:
updateDashboardRequest-- Returns:
- A Java Future containing the result of the UpdateDashboard operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- LimitExceededException A limit is exceeded.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDashboard
default CompletableFuture<UpdateDashboardResponse> updateDashboard(Consumer<UpdateDashboardRequest.Builder> updateDashboardRequest) Updates a dashboard in an Amazon Web Services account.
Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the
UpdateDashboardPublishedVersionAPI operation.
This is a convenience which creates an instance of the
UpdateDashboardRequest.Builderavoiding the need to create one manually viaUpdateDashboardRequest.builder()- Parameters:
updateDashboardRequest- AConsumerthat will call methods onUpdateDashboardRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateDashboard operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- LimitExceededException A limit is exceeded.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDashboardLinks
default CompletableFuture<UpdateDashboardLinksResponse> updateDashboardLinks(UpdateDashboardLinksRequest updateDashboardLinksRequest) Updates the linked analyses on a dashboard.
- Parameters:
updateDashboardLinksRequest-- Returns:
- A Java Future containing the result of the UpdateDashboardLinks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDashboardLinks
default CompletableFuture<UpdateDashboardLinksResponse> updateDashboardLinks(Consumer<UpdateDashboardLinksRequest.Builder> updateDashboardLinksRequest) Updates the linked analyses on a dashboard.
This is a convenience which creates an instance of the
UpdateDashboardLinksRequest.Builderavoiding the need to create one manually viaUpdateDashboardLinksRequest.builder()- Parameters:
updateDashboardLinksRequest- AConsumerthat will call methods onUpdateDashboardLinksRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateDashboardLinks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDashboardPermissions
default CompletableFuture<UpdateDashboardPermissionsResponse> updateDashboardPermissions(UpdateDashboardPermissionsRequest updateDashboardPermissionsRequest) Updates read and write permissions on a dashboard.
- Parameters:
updateDashboardPermissionsRequest-- Returns:
- A Java Future containing the result of the UpdateDashboardPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDashboardPermissions
default CompletableFuture<UpdateDashboardPermissionsResponse> updateDashboardPermissions(Consumer<UpdateDashboardPermissionsRequest.Builder> updateDashboardPermissionsRequest) Updates read and write permissions on a dashboard.
This is a convenience which creates an instance of the
UpdateDashboardPermissionsRequest.Builderavoiding the need to create one manually viaUpdateDashboardPermissionsRequest.builder()- Parameters:
updateDashboardPermissionsRequest- AConsumerthat will call methods onUpdateDashboardPermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateDashboardPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDashboardPublishedVersion
default CompletableFuture<UpdateDashboardPublishedVersionResponse> updateDashboardPublishedVersion(UpdateDashboardPublishedVersionRequest updateDashboardPublishedVersionRequest) Updates the published version of a dashboard.
- Parameters:
updateDashboardPublishedVersionRequest-- Returns:
- A Java Future containing the result of the UpdateDashboardPublishedVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDashboardPublishedVersion
default CompletableFuture<UpdateDashboardPublishedVersionResponse> updateDashboardPublishedVersion(Consumer<UpdateDashboardPublishedVersionRequest.Builder> updateDashboardPublishedVersionRequest) Updates the published version of a dashboard.
This is a convenience which creates an instance of the
UpdateDashboardPublishedVersionRequest.Builderavoiding the need to create one manually viaUpdateDashboardPublishedVersionRequest.builder()- Parameters:
updateDashboardPublishedVersionRequest- AConsumerthat will call methods onUpdateDashboardPublishedVersionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateDashboardPublishedVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDashboardsQAConfiguration
default CompletableFuture<UpdateDashboardsQaConfigurationResponse> updateDashboardsQAConfiguration(UpdateDashboardsQaConfigurationRequest updateDashboardsQaConfigurationRequest) Updates a Dashboard QA configuration.
- Parameters:
updateDashboardsQaConfigurationRequest-- Returns:
- A Java Future containing the result of the UpdateDashboardsQAConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDashboardsQAConfiguration
default CompletableFuture<UpdateDashboardsQaConfigurationResponse> updateDashboardsQAConfiguration(Consumer<UpdateDashboardsQaConfigurationRequest.Builder> updateDashboardsQaConfigurationRequest) Updates a Dashboard QA configuration.
This is a convenience which creates an instance of the
UpdateDashboardsQaConfigurationRequest.Builderavoiding the need to create one manually viaUpdateDashboardsQaConfigurationRequest.builder()- Parameters:
updateDashboardsQaConfigurationRequest- AConsumerthat will call methods onUpdateDashboardsQaConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateDashboardsQAConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDataSet
default CompletableFuture<UpdateDataSetResponse> updateDataSet(UpdateDataSetRequest updateDataSetRequest) Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.
- Parameters:
updateDataSetRequest-- Returns:
- A Java Future containing the result of the UpdateDataSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDataSet
default CompletableFuture<UpdateDataSetResponse> updateDataSet(Consumer<UpdateDataSetRequest.Builder> updateDataSetRequest) Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.
This is a convenience which creates an instance of the
UpdateDataSetRequest.Builderavoiding the need to create one manually viaUpdateDataSetRequest.builder()- Parameters:
updateDataSetRequest- AConsumerthat will call methods onUpdateDataSetRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateDataSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDataSetPermissions
default CompletableFuture<UpdateDataSetPermissionsResponse> updateDataSetPermissions(UpdateDataSetPermissionsRequest updateDataSetPermissionsRequest) Updates the permissions on a dataset.
The permissions resource is
arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.- Parameters:
updateDataSetPermissionsRequest-- Returns:
- A Java Future containing the result of the UpdateDataSetPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDataSetPermissions
default CompletableFuture<UpdateDataSetPermissionsResponse> updateDataSetPermissions(Consumer<UpdateDataSetPermissionsRequest.Builder> updateDataSetPermissionsRequest) Updates the permissions on a dataset.
The permissions resource is
arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
This is a convenience which creates an instance of the
UpdateDataSetPermissionsRequest.Builderavoiding the need to create one manually viaUpdateDataSetPermissionsRequest.builder()- Parameters:
updateDataSetPermissionsRequest- AConsumerthat will call methods onUpdateDataSetPermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateDataSetPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDataSource
default CompletableFuture<UpdateDataSourceResponse> updateDataSource(UpdateDataSourceRequest updateDataSourceRequest) Updates a data source.
- Parameters:
updateDataSourceRequest-- Returns:
- A Java Future containing the result of the UpdateDataSource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- CustomerManagedKeyUnavailableException The customer managed key that is registered to your Amazon Quick Sight account is unavailable.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDataSource
default CompletableFuture<UpdateDataSourceResponse> updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest) Updates a data source.
This is a convenience which creates an instance of the
UpdateDataSourceRequest.Builderavoiding the need to create one manually viaUpdateDataSourceRequest.builder()- Parameters:
updateDataSourceRequest- AConsumerthat will call methods onUpdateDataSourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateDataSource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- CustomerManagedKeyUnavailableException The customer managed key that is registered to your Amazon Quick Sight account is unavailable.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDataSourcePermissions
default CompletableFuture<UpdateDataSourcePermissionsResponse> updateDataSourcePermissions(UpdateDataSourcePermissionsRequest updateDataSourcePermissionsRequest) Updates the permissions to a data source.
- Parameters:
updateDataSourcePermissionsRequest-- Returns:
- A Java Future containing the result of the UpdateDataSourcePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDataSourcePermissions
default CompletableFuture<UpdateDataSourcePermissionsResponse> updateDataSourcePermissions(Consumer<UpdateDataSourcePermissionsRequest.Builder> updateDataSourcePermissionsRequest) Updates the permissions to a data source.
This is a convenience which creates an instance of the
UpdateDataSourcePermissionsRequest.Builderavoiding the need to create one manually viaUpdateDataSourcePermissionsRequest.builder()- Parameters:
updateDataSourcePermissionsRequest- AConsumerthat will call methods onUpdateDataSourcePermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateDataSourcePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDefaultQBusinessApplication
default CompletableFuture<UpdateDefaultQBusinessApplicationResponse> updateDefaultQBusinessApplication(UpdateDefaultQBusinessApplicationRequest updateDefaultQBusinessApplicationRequest) Updates a Amazon Q Business application that is linked to a Quick Sight account.
- Parameters:
updateDefaultQBusinessApplicationRequest-- Returns:
- A Java Future containing the result of the UpdateDefaultQBusinessApplication operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDefaultQBusinessApplication
default CompletableFuture<UpdateDefaultQBusinessApplicationResponse> updateDefaultQBusinessApplication(Consumer<UpdateDefaultQBusinessApplicationRequest.Builder> updateDefaultQBusinessApplicationRequest) Updates a Amazon Q Business application that is linked to a Quick Sight account.
This is a convenience which creates an instance of the
UpdateDefaultQBusinessApplicationRequest.Builderavoiding the need to create one manually viaUpdateDefaultQBusinessApplicationRequest.builder()- Parameters:
updateDefaultQBusinessApplicationRequest- AConsumerthat will call methods onUpdateDefaultQBusinessApplicationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateDefaultQBusinessApplication operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateFlowPermissions
default CompletableFuture<UpdateFlowPermissionsResponse> updateFlowPermissions(UpdateFlowPermissionsRequest updateFlowPermissionsRequest) Updates permissions against principals on a flow.
- Parameters:
updateFlowPermissionsRequest-- Returns:
- A Java Future containing the result of the UpdateFlowPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateFlowPermissions
default CompletableFuture<UpdateFlowPermissionsResponse> updateFlowPermissions(Consumer<UpdateFlowPermissionsRequest.Builder> updateFlowPermissionsRequest) Updates permissions against principals on a flow.
This is a convenience which creates an instance of the
UpdateFlowPermissionsRequest.Builderavoiding the need to create one manually viaUpdateFlowPermissionsRequest.builder()- Parameters:
updateFlowPermissionsRequest- AConsumerthat will call methods onUpdateFlowPermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateFlowPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InternalFailureException An internal failure occurred.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateFolder
default CompletableFuture<UpdateFolderResponse> updateFolder(UpdateFolderRequest updateFolderRequest) Updates the name of a folder.
- Parameters:
updateFolderRequest-- Returns:
- A Java Future containing the result of the UpdateFolder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateFolder
default CompletableFuture<UpdateFolderResponse> updateFolder(Consumer<UpdateFolderRequest.Builder> updateFolderRequest) Updates the name of a folder.
This is a convenience which creates an instance of the
UpdateFolderRequest.Builderavoiding the need to create one manually viaUpdateFolderRequest.builder()- Parameters:
updateFolderRequest- AConsumerthat will call methods onUpdateFolderRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateFolder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateFolderPermissions
default CompletableFuture<UpdateFolderPermissionsResponse> updateFolderPermissions(UpdateFolderPermissionsRequest updateFolderPermissionsRequest) Updates permissions of a folder.
- Parameters:
updateFolderPermissionsRequest-- Returns:
- A Java Future containing the result of the UpdateFolderPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateFolderPermissions
default CompletableFuture<UpdateFolderPermissionsResponse> updateFolderPermissions(Consumer<UpdateFolderPermissionsRequest.Builder> updateFolderPermissionsRequest) Updates permissions of a folder.
This is a convenience which creates an instance of the
UpdateFolderPermissionsRequest.Builderavoiding the need to create one manually viaUpdateFolderPermissionsRequest.builder()- Parameters:
updateFolderPermissionsRequest- AConsumerthat will call methods onUpdateFolderPermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateFolderPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateGroup
Changes a group description.
- Parameters:
updateGroupRequest-- Returns:
- A Java Future containing the result of the UpdateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateGroup
default CompletableFuture<UpdateGroupResponse> updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest) Changes a group description.
This is a convenience which creates an instance of the
UpdateGroupRequest.Builderavoiding the need to create one manually viaUpdateGroupRequest.builder()- Parameters:
updateGroupRequest- AConsumerthat will call methods onUpdateGroupRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateIAMPolicyAssignment
default CompletableFuture<UpdateIamPolicyAssignmentResponse> updateIAMPolicyAssignment(UpdateIamPolicyAssignmentRequest updateIamPolicyAssignmentRequest) Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in
Identities.- Parameters:
updateIamPolicyAssignmentRequest-- Returns:
- A Java Future containing the result of the UpdateIAMPolicyAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConcurrentUpdatingException A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateIAMPolicyAssignment
default CompletableFuture<UpdateIamPolicyAssignmentResponse> updateIAMPolicyAssignment(Consumer<UpdateIamPolicyAssignmentRequest.Builder> updateIamPolicyAssignmentRequest) Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in
Identities.
This is a convenience which creates an instance of the
UpdateIamPolicyAssignmentRequest.Builderavoiding the need to create one manually viaUpdateIamPolicyAssignmentRequest.builder()- Parameters:
updateIamPolicyAssignmentRequest- AConsumerthat will call methods onUpdateIamPolicyAssignmentRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateIAMPolicyAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConcurrentUpdatingException A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateIdentityPropagationConfig
default CompletableFuture<UpdateIdentityPropagationConfigResponse> updateIdentityPropagationConfig(UpdateIdentityPropagationConfigRequest updateIdentityPropagationConfigRequest) Adds or updates services and authorized targets to configure what the Quick Sight IAM Identity Center application can access.
This operation is only supported for Quick Sight accounts using IAM Identity Center
- Parameters:
updateIdentityPropagationConfigRequest-- Returns:
- A Java Future containing the result of the UpdateIdentityPropagationConfig operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateIdentityPropagationConfig
default CompletableFuture<UpdateIdentityPropagationConfigResponse> updateIdentityPropagationConfig(Consumer<UpdateIdentityPropagationConfigRequest.Builder> updateIdentityPropagationConfigRequest) Adds or updates services and authorized targets to configure what the Quick Sight IAM Identity Center application can access.
This operation is only supported for Quick Sight accounts using IAM Identity Center
This is a convenience which creates an instance of the
UpdateIdentityPropagationConfigRequest.Builderavoiding the need to create one manually viaUpdateIdentityPropagationConfigRequest.builder()- Parameters:
updateIdentityPropagationConfigRequest- AConsumerthat will call methods onUpdateIdentityPropagationConfigRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateIdentityPropagationConfig operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateIpRestriction
default CompletableFuture<UpdateIpRestrictionResponse> updateIpRestriction(UpdateIpRestrictionRequest updateIpRestrictionRequest) Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the
IpRestrictionRule,VpcIdRestrictionRule, orVpcEndpointIdRestrictionRule. To use this operation, you must provide the entire map of rules. You can use theDescribeIpRestrictionoperation to get the current rule map.- Parameters:
updateIpRestrictionRequest-- Returns:
- A Java Future containing the result of the UpdateIpRestriction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- LimitExceededException A limit is exceeded.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateIpRestriction
default CompletableFuture<UpdateIpRestrictionResponse> updateIpRestriction(Consumer<UpdateIpRestrictionRequest.Builder> updateIpRestrictionRequest) Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the
IpRestrictionRule,VpcIdRestrictionRule, orVpcEndpointIdRestrictionRule. To use this operation, you must provide the entire map of rules. You can use theDescribeIpRestrictionoperation to get the current rule map.
This is a convenience which creates an instance of the
UpdateIpRestrictionRequest.Builderavoiding the need to create one manually viaUpdateIpRestrictionRequest.builder()- Parameters:
updateIpRestrictionRequest- AConsumerthat will call methods onUpdateIpRestrictionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateIpRestriction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- LimitExceededException A limit is exceeded.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateKeyRegistration
default CompletableFuture<UpdateKeyRegistrationResponse> updateKeyRegistration(UpdateKeyRegistrationRequest updateKeyRegistrationRequest) Updates a customer managed key in a Quick Sight account.
- Parameters:
updateKeyRegistrationRequest-- Returns:
- A Java Future containing the result of the UpdateKeyRegistration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateKeyRegistration
default CompletableFuture<UpdateKeyRegistrationResponse> updateKeyRegistration(Consumer<UpdateKeyRegistrationRequest.Builder> updateKeyRegistrationRequest) Updates a customer managed key in a Quick Sight account.
This is a convenience which creates an instance of the
UpdateKeyRegistrationRequest.Builderavoiding the need to create one manually viaUpdateKeyRegistrationRequest.builder()- Parameters:
updateKeyRegistrationRequest- AConsumerthat will call methods onUpdateKeyRegistrationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateKeyRegistration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePublicSharingSettings
default CompletableFuture<UpdatePublicSharingSettingsResponse> updatePublicSharingSettings(UpdatePublicSharingSettingsRequest updatePublicSharingSettingsRequest) This API controls public sharing settings for your entire Quick Sight account, affecting data security and access. When you enable public sharing:
-
Dashboards can be shared publicly
-
This setting affects your entire Amazon Web Services account and all Quick Sight users
Before proceeding: Ensure you understand the security implications and have proper IAM permissions configured.
Use the
UpdatePublicSharingSettingsoperation to turn on or turn off the public sharing settings of an Amazon Quick Sight dashboard.To use this operation, turn on session capacity pricing for your Amazon Quick Sight account.
Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon Quick Sight, see Using QuickSight with IAM in the Amazon Quick Sight User Guide.
- Parameters:
updatePublicSharingSettingsRequest-- Returns:
- A Java Future containing the result of the UpdatePublicSharingSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedPricingPlanException This error indicates that you are calling an embedding operation in
Amazon Quick Sight without the required pricing plan on your Amazon Web Services account. Before you can
use embedding for anonymous users, a Quick Suite administrator needs to add capacity pricing to Quick
Sight. You can do this on the Manage Quick Suite page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrlAPI operation with the--identity-type ANONYMOUSoption. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updatePublicSharingSettings
default CompletableFuture<UpdatePublicSharingSettingsResponse> updatePublicSharingSettings(Consumer<UpdatePublicSharingSettingsRequest.Builder> updatePublicSharingSettingsRequest) This API controls public sharing settings for your entire Quick Sight account, affecting data security and access. When you enable public sharing:
-
Dashboards can be shared publicly
-
This setting affects your entire Amazon Web Services account and all Quick Sight users
Before proceeding: Ensure you understand the security implications and have proper IAM permissions configured.
Use the
UpdatePublicSharingSettingsoperation to turn on or turn off the public sharing settings of an Amazon Quick Sight dashboard.To use this operation, turn on session capacity pricing for your Amazon Quick Sight account.
Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon Quick Sight, see Using QuickSight with IAM in the Amazon Quick Sight User Guide.
This is a convenience which creates an instance of the
UpdatePublicSharingSettingsRequest.Builderavoiding the need to create one manually viaUpdatePublicSharingSettingsRequest.builder()- Parameters:
updatePublicSharingSettingsRequest- AConsumerthat will call methods onUpdatePublicSharingSettingsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdatePublicSharingSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedPricingPlanException This error indicates that you are calling an embedding operation in
Amazon Quick Sight without the required pricing plan on your Amazon Web Services account. Before you can
use embedding for anonymous users, a Quick Suite administrator needs to add capacity pricing to Quick
Sight. You can do this on the Manage Quick Suite page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrlAPI operation with the--identity-type ANONYMOUSoption. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateQPersonalizationConfiguration
default CompletableFuture<UpdateQPersonalizationConfigurationResponse> updateQPersonalizationConfiguration(UpdateQPersonalizationConfigurationRequest updateQPersonalizationConfigurationRequest) Updates a personalization configuration.
- Parameters:
updateQPersonalizationConfigurationRequest-- Returns:
- A Java Future containing the result of the UpdateQPersonalizationConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateQPersonalizationConfiguration
default CompletableFuture<UpdateQPersonalizationConfigurationResponse> updateQPersonalizationConfiguration(Consumer<UpdateQPersonalizationConfigurationRequest.Builder> updateQPersonalizationConfigurationRequest) Updates a personalization configuration.
This is a convenience which creates an instance of the
UpdateQPersonalizationConfigurationRequest.Builderavoiding the need to create one manually viaUpdateQPersonalizationConfigurationRequest.builder()- Parameters:
updateQPersonalizationConfigurationRequest- AConsumerthat will call methods onUpdateQPersonalizationConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateQPersonalizationConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateQuickSightQSearchConfiguration
default CompletableFuture<UpdateQuickSightQSearchConfigurationResponse> updateQuickSightQSearchConfiguration(UpdateQuickSightQSearchConfigurationRequest updateQuickSightQSearchConfigurationRequest) Updates the state of a Quick Sight Q Search configuration.
- Parameters:
updateQuickSightQSearchConfigurationRequest-- Returns:
- A Java Future containing the result of the UpdateQuickSightQSearchConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateQuickSightQSearchConfiguration
default CompletableFuture<UpdateQuickSightQSearchConfigurationResponse> updateQuickSightQSearchConfiguration(Consumer<UpdateQuickSightQSearchConfigurationRequest.Builder> updateQuickSightQSearchConfigurationRequest) Updates the state of a Quick Sight Q Search configuration.
This is a convenience which creates an instance of the
UpdateQuickSightQSearchConfigurationRequest.Builderavoiding the need to create one manually viaUpdateQuickSightQSearchConfigurationRequest.builder()- Parameters:
updateQuickSightQSearchConfigurationRequest- AConsumerthat will call methods onUpdateQuickSightQSearchConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateQuickSightQSearchConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRefreshSchedule
default CompletableFuture<UpdateRefreshScheduleResponse> updateRefreshSchedule(UpdateRefreshScheduleRequest updateRefreshScheduleRequest) Updates a refresh schedule for a dataset.
- Parameters:
updateRefreshScheduleRequest-- Returns:
- A Java Future containing the result of the UpdateRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRefreshSchedule
default CompletableFuture<UpdateRefreshScheduleResponse> updateRefreshSchedule(Consumer<UpdateRefreshScheduleRequest.Builder> updateRefreshScheduleRequest) Updates a refresh schedule for a dataset.
This is a convenience which creates an instance of the
UpdateRefreshScheduleRequest.Builderavoiding the need to create one manually viaUpdateRefreshScheduleRequest.builder()- Parameters:
updateRefreshScheduleRequest- AConsumerthat will call methods onUpdateRefreshScheduleRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRoleCustomPermission
default CompletableFuture<UpdateRoleCustomPermissionResponse> updateRoleCustomPermission(UpdateRoleCustomPermissionRequest updateRoleCustomPermissionRequest) Updates the custom permissions that are associated with a role.
- Parameters:
updateRoleCustomPermissionRequest-- Returns:
- A Java Future containing the result of the UpdateRoleCustomPermission operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRoleCustomPermission
default CompletableFuture<UpdateRoleCustomPermissionResponse> updateRoleCustomPermission(Consumer<UpdateRoleCustomPermissionRequest.Builder> updateRoleCustomPermissionRequest) Updates the custom permissions that are associated with a role.
This is a convenience which creates an instance of the
UpdateRoleCustomPermissionRequest.Builderavoiding the need to create one manually viaUpdateRoleCustomPermissionRequest.builder()- Parameters:
updateRoleCustomPermissionRequest- AConsumerthat will call methods onUpdateRoleCustomPermissionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateRoleCustomPermission operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateSPICECapacityConfiguration
default CompletableFuture<UpdateSpiceCapacityConfigurationResponse> updateSPICECapacityConfiguration(UpdateSpiceCapacityConfigurationRequest updateSpiceCapacityConfigurationRequest) Updates the SPICE capacity configuration for a Quick Sight account.
- Parameters:
updateSpiceCapacityConfigurationRequest-- Returns:
- A Java Future containing the result of the UpdateSPICECapacityConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateSPICECapacityConfiguration
default CompletableFuture<UpdateSpiceCapacityConfigurationResponse> updateSPICECapacityConfiguration(Consumer<UpdateSpiceCapacityConfigurationRequest.Builder> updateSpiceCapacityConfigurationRequest) Updates the SPICE capacity configuration for a Quick Sight account.
This is a convenience which creates an instance of the
UpdateSpiceCapacityConfigurationRequest.Builderavoiding the need to create one manually viaUpdateSpiceCapacityConfigurationRequest.builder()- Parameters:
updateSpiceCapacityConfigurationRequest- AConsumerthat will call methods onUpdateSpiceCapacityConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateSPICECapacityConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTemplate
default CompletableFuture<UpdateTemplateResponse> updateTemplate(UpdateTemplateRequest updateTemplateRequest) Updates a template from an existing Amazon Quick Sight analysis or another template.
- Parameters:
updateTemplateRequest-- Returns:
- A Java Future containing the result of the UpdateTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- LimitExceededException A limit is exceeded.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTemplate
default CompletableFuture<UpdateTemplateResponse> updateTemplate(Consumer<UpdateTemplateRequest.Builder> updateTemplateRequest) Updates a template from an existing Amazon Quick Sight analysis or another template.
This is a convenience which creates an instance of the
UpdateTemplateRequest.Builderavoiding the need to create one manually viaUpdateTemplateRequest.builder()- Parameters:
updateTemplateRequest- AConsumerthat will call methods onUpdateTemplateRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- LimitExceededException A limit is exceeded.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTemplateAlias
default CompletableFuture<UpdateTemplateAliasResponse> updateTemplateAlias(UpdateTemplateAliasRequest updateTemplateAliasRequest) Updates the template alias of a template.
- Parameters:
updateTemplateAliasRequest-- Returns:
- A Java Future containing the result of the UpdateTemplateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTemplateAlias
default CompletableFuture<UpdateTemplateAliasResponse> updateTemplateAlias(Consumer<UpdateTemplateAliasRequest.Builder> updateTemplateAliasRequest) Updates the template alias of a template.
This is a convenience which creates an instance of the
UpdateTemplateAliasRequest.Builderavoiding the need to create one manually viaUpdateTemplateAliasRequest.builder()- Parameters:
updateTemplateAliasRequest- AConsumerthat will call methods onUpdateTemplateAliasRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateTemplateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTemplatePermissions
default CompletableFuture<UpdateTemplatePermissionsResponse> updateTemplatePermissions(UpdateTemplatePermissionsRequest updateTemplatePermissionsRequest) Updates the resource permissions for a template.
- Parameters:
updateTemplatePermissionsRequest-- Returns:
- A Java Future containing the result of the UpdateTemplatePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTemplatePermissions
default CompletableFuture<UpdateTemplatePermissionsResponse> updateTemplatePermissions(Consumer<UpdateTemplatePermissionsRequest.Builder> updateTemplatePermissionsRequest) Updates the resource permissions for a template.
This is a convenience which creates an instance of the
UpdateTemplatePermissionsRequest.Builderavoiding the need to create one manually viaUpdateTemplatePermissionsRequest.builder()- Parameters:
updateTemplatePermissionsRequest- AConsumerthat will call methods onUpdateTemplatePermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateTemplatePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTheme
Updates a theme.
- Parameters:
updateThemeRequest-- Returns:
- A Java Future containing the result of the UpdateTheme operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTheme
default CompletableFuture<UpdateThemeResponse> updateTheme(Consumer<UpdateThemeRequest.Builder> updateThemeRequest) Updates a theme.
This is a convenience which creates an instance of the
UpdateThemeRequest.Builderavoiding the need to create one manually viaUpdateThemeRequest.builder()- Parameters:
updateThemeRequest- AConsumerthat will call methods onUpdateThemeRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateTheme operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateThemeAlias
default CompletableFuture<UpdateThemeAliasResponse> updateThemeAlias(UpdateThemeAliasRequest updateThemeAliasRequest) Updates an alias of a theme.
- Parameters:
updateThemeAliasRequest-- Returns:
- A Java Future containing the result of the UpdateThemeAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateThemeAlias
default CompletableFuture<UpdateThemeAliasResponse> updateThemeAlias(Consumer<UpdateThemeAliasRequest.Builder> updateThemeAliasRequest) Updates an alias of a theme.
This is a convenience which creates an instance of the
UpdateThemeAliasRequest.Builderavoiding the need to create one manually viaUpdateThemeAliasRequest.builder()- Parameters:
updateThemeAliasRequest- AConsumerthat will call methods onUpdateThemeAliasRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateThemeAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateThemePermissions
default CompletableFuture<UpdateThemePermissionsResponse> updateThemePermissions(UpdateThemePermissionsRequest updateThemePermissionsRequest) Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example
"quicksight:DescribeTheme".Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions:
-
User
-
"quicksight:DescribeTheme" -
"quicksight:DescribeThemeAlias" -
"quicksight:ListThemeAliases" -
"quicksight:ListThemeVersions"
-
-
Owner
-
"quicksight:DescribeTheme" -
"quicksight:DescribeThemeAlias" -
"quicksight:ListThemeAliases" -
"quicksight:ListThemeVersions" -
"quicksight:DeleteTheme" -
"quicksight:UpdateTheme" -
"quicksight:CreateThemeAlias" -
"quicksight:DeleteThemeAlias" -
"quicksight:UpdateThemeAlias" -
"quicksight:UpdateThemePermissions" -
"quicksight:DescribeThemePermissions"
-
-
To specify no permissions, omit the permissions list.
- Parameters:
updateThemePermissionsRequest-- Returns:
- A Java Future containing the result of the UpdateThemePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateThemePermissions
default CompletableFuture<UpdateThemePermissionsResponse> updateThemePermissions(Consumer<UpdateThemePermissionsRequest.Builder> updateThemePermissionsRequest) Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example
"quicksight:DescribeTheme".Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions:
-
User
-
"quicksight:DescribeTheme" -
"quicksight:DescribeThemeAlias" -
"quicksight:ListThemeAliases" -
"quicksight:ListThemeVersions"
-
-
Owner
-
"quicksight:DescribeTheme" -
"quicksight:DescribeThemeAlias" -
"quicksight:ListThemeAliases" -
"quicksight:ListThemeVersions" -
"quicksight:DeleteTheme" -
"quicksight:UpdateTheme" -
"quicksight:CreateThemeAlias" -
"quicksight:DeleteThemeAlias" -
"quicksight:UpdateThemeAlias" -
"quicksight:UpdateThemePermissions" -
"quicksight:DescribeThemePermissions"
-
-
To specify no permissions, omit the permissions list.
This is a convenience which creates an instance of the
UpdateThemePermissionsRequest.Builderavoiding the need to create one manually viaUpdateThemePermissionsRequest.builder()- Parameters:
updateThemePermissionsRequest- AConsumerthat will call methods onUpdateThemePermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateThemePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateTopic
Updates a topic.
- Parameters:
updateTopicRequest-- Returns:
- A Java Future containing the result of the UpdateTopic operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTopic
default CompletableFuture<UpdateTopicResponse> updateTopic(Consumer<UpdateTopicRequest.Builder> updateTopicRequest) Updates a topic.
This is a convenience which creates an instance of the
UpdateTopicRequest.Builderavoiding the need to create one manually viaUpdateTopicRequest.builder()- Parameters:
updateTopicRequest- AConsumerthat will call methods onUpdateTopicRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateTopic operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTopicPermissions
default CompletableFuture<UpdateTopicPermissionsResponse> updateTopicPermissions(UpdateTopicPermissionsRequest updateTopicPermissionsRequest) Updates the permissions of a topic.
- Parameters:
updateTopicPermissionsRequest-- Returns:
- A Java Future containing the result of the UpdateTopicPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTopicPermissions
default CompletableFuture<UpdateTopicPermissionsResponse> updateTopicPermissions(Consumer<UpdateTopicPermissionsRequest.Builder> updateTopicPermissionsRequest) Updates the permissions of a topic.
This is a convenience which creates an instance of the
UpdateTopicPermissionsRequest.Builderavoiding the need to create one manually viaUpdateTopicPermissionsRequest.builder()- Parameters:
updateTopicPermissionsRequest- AConsumerthat will call methods onUpdateTopicPermissionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateTopicPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTopicRefreshSchedule
default CompletableFuture<UpdateTopicRefreshScheduleResponse> updateTopicRefreshSchedule(UpdateTopicRefreshScheduleRequest updateTopicRefreshScheduleRequest) Updates a topic refresh schedule.
- Parameters:
updateTopicRefreshScheduleRequest-- Returns:
- A Java Future containing the result of the UpdateTopicRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTopicRefreshSchedule
default CompletableFuture<UpdateTopicRefreshScheduleResponse> updateTopicRefreshSchedule(Consumer<UpdateTopicRefreshScheduleRequest.Builder> updateTopicRefreshScheduleRequest) Updates a topic refresh schedule.
This is a convenience which creates an instance of the
UpdateTopicRefreshScheduleRequest.Builderavoiding the need to create one manually viaUpdateTopicRefreshScheduleRequest.builder()- Parameters:
updateTopicRefreshScheduleRequest- AConsumerthat will call methods onUpdateTopicRefreshScheduleRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateTopicRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateUser
Updates an Amazon Quick Sight user.
- Parameters:
updateUserRequest-- Returns:
- A Java Future containing the result of the UpdateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateUser
default CompletableFuture<UpdateUserResponse> updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) Updates an Amazon Quick Sight user.
This is a convenience which creates an instance of the
UpdateUserRequest.Builderavoiding the need to create one manually viaUpdateUserRequest.builder()- Parameters:
updateUserRequest- AConsumerthat will call methods onUpdateUserRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateUserCustomPermission
default CompletableFuture<UpdateUserCustomPermissionResponse> updateUserCustomPermission(UpdateUserCustomPermissionRequest updateUserCustomPermissionRequest) Updates a custom permissions profile for a user.
- Parameters:
updateUserCustomPermissionRequest-- Returns:
- A Java Future containing the result of the UpdateUserCustomPermission operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateUserCustomPermission
default CompletableFuture<UpdateUserCustomPermissionResponse> updateUserCustomPermission(Consumer<UpdateUserCustomPermissionRequest.Builder> updateUserCustomPermissionRequest) Updates a custom permissions profile for a user.
This is a convenience which creates an instance of the
UpdateUserCustomPermissionRequest.Builderavoiding the need to create one manually viaUpdateUserCustomPermissionRequest.builder()- Parameters:
updateUserCustomPermissionRequest- AConsumerthat will call methods onUpdateUserCustomPermissionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateUserCustomPermission operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateVPCConnection
default CompletableFuture<UpdateVpcConnectionResponse> updateVPCConnection(UpdateVpcConnectionRequest updateVpcConnectionRequest) Updates a VPC connection.
- Parameters:
updateVpcConnectionRequest-- Returns:
- A Java Future containing the result of the UpdateVPCConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateVPCConnection
default CompletableFuture<UpdateVpcConnectionResponse> updateVPCConnection(Consumer<UpdateVpcConnectionRequest.Builder> updateVpcConnectionRequest) Updates a VPC connection.
This is a convenience which creates an instance of the
UpdateVpcConnectionRequest.Builderavoiding the need to create one manually viaUpdateVpcConnectionRequest.builder()- Parameters:
updateVpcConnectionRequest- AConsumerthat will call methods onUpdateVpcConnectionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateVPCConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aQuickSightAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aQuickSightAsyncClient.
-