Package software.amazon.awssdk.services.quicksight

Interface QuickSightClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface QuickSightClient
extends AwsClient

Service client for accessing Amazon QuickSight. This can be created using the static builder() method. Amazon QuickSight API Reference

Amazon QuickSight is a fully managed, serverless business intelligence service for the Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static QuickSightClientBuilder	builder()	Create a builder that can be used to configure and create a QuickSightClient.
default CancelIngestionResponse	cancelIngestion(Consumer<CancelIngestionRequest.Builder> cancelIngestionRequest)	Cancels an ongoing ingestion of data into SPICE.
default CancelIngestionResponse	cancelIngestion(CancelIngestionRequest cancelIngestionRequest)	Cancels an ongoing ingestion of data into SPICE.
static QuickSightClient	create()	Create a QuickSightClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateAccountCustomizationResponse	createAccountCustomization(Consumer<CreateAccountCustomizationRequest.Builder> createAccountCustomizationRequest)	Creates Amazon QuickSight customizations for the current Amazon Web Services Region.
default CreateAccountCustomizationResponse	createAccountCustomization(CreateAccountCustomizationRequest createAccountCustomizationRequest)	Creates Amazon QuickSight customizations for the current Amazon Web Services Region.
default CreateAccountSubscriptionResponse	createAccountSubscription(Consumer<CreateAccountSubscriptionRequest.Builder> createAccountSubscriptionRequest)	Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.
default CreateAccountSubscriptionResponse	createAccountSubscription(CreateAccountSubscriptionRequest createAccountSubscriptionRequest)	Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.
default CreateAnalysisResponse	createAnalysis(Consumer<CreateAnalysisRequest.Builder> createAnalysisRequest)	Creates an analysis in Amazon QuickSight.
default CreateAnalysisResponse	createAnalysis(CreateAnalysisRequest createAnalysisRequest)	Creates an analysis in Amazon QuickSight.
default CreateDashboardResponse	createDashboard(Consumer<CreateDashboardRequest.Builder> createDashboardRequest)	Creates a dashboard from either a template or directly with a DashboardDefinition.
default CreateDashboardResponse	createDashboard(CreateDashboardRequest createDashboardRequest)	Creates a dashboard from either a template or directly with a DashboardDefinition.
default CreateDataSetResponse	createDataSet(Consumer<CreateDataSetRequest.Builder> createDataSetRequest)	Creates a dataset.
default CreateDataSetResponse	createDataSet(CreateDataSetRequest createDataSetRequest)	Creates a dataset.
default CreateDataSourceResponse	createDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest)	Creates a data source.
default CreateDataSourceResponse	createDataSource(CreateDataSourceRequest createDataSourceRequest)	Creates a data source.
default CreateFolderResponse	createFolder(Consumer<CreateFolderRequest.Builder> createFolderRequest)	Creates an empty shared folder.
default CreateFolderResponse	createFolder(CreateFolderRequest createFolderRequest)	Creates an empty shared folder.
default CreateFolderMembershipResponse	createFolderMembership(Consumer<CreateFolderMembershipRequest.Builder> createFolderMembershipRequest)	Adds an asset, such as a dashboard, analysis, or dataset into a folder.
default CreateFolderMembershipResponse	createFolderMembership(CreateFolderMembershipRequest createFolderMembershipRequest)	Adds an asset, such as a dashboard, analysis, or dataset into a folder.
default CreateGroupResponse	createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)	Use the CreateGroup operation to create a group in Amazon QuickSight.
default CreateGroupResponse	createGroup(CreateGroupRequest createGroupRequest)	Use the CreateGroup operation to create a group in Amazon QuickSight.
default CreateGroupMembershipResponse	createGroupMembership(Consumer<CreateGroupMembershipRequest.Builder> createGroupMembershipRequest)	Adds an Amazon QuickSight user to an Amazon QuickSight group.
default CreateGroupMembershipResponse	createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest)	Adds an Amazon QuickSight user to an Amazon QuickSight group.
default CreateIamPolicyAssignmentResponse	createIAMPolicyAssignment(Consumer<CreateIamPolicyAssignmentRequest.Builder> createIamPolicyAssignmentRequest)	Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN).
default CreateIamPolicyAssignmentResponse	createIAMPolicyAssignment(CreateIamPolicyAssignmentRequest createIamPolicyAssignmentRequest)	Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN).
default CreateIngestionResponse	createIngestion(Consumer<CreateIngestionRequest.Builder> createIngestionRequest)	Creates and starts a new SPICE ingestion for a dataset.
default CreateIngestionResponse	createIngestion(CreateIngestionRequest createIngestionRequest)	Creates and starts a new SPICE ingestion for a dataset.
default CreateNamespaceResponse	createNamespace(Consumer<CreateNamespaceRequest.Builder> createNamespaceRequest)	(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
default CreateNamespaceResponse	createNamespace(CreateNamespaceRequest createNamespaceRequest)	(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
default CreateRefreshScheduleResponse	createRefreshSchedule(Consumer<CreateRefreshScheduleRequest.Builder> createRefreshScheduleRequest)	Creates a refresh schedule for a dataset.
default CreateRefreshScheduleResponse	createRefreshSchedule(CreateRefreshScheduleRequest createRefreshScheduleRequest)	Creates a refresh schedule for a dataset.
default CreateTemplateResponse	createTemplate(Consumer<CreateTemplateRequest.Builder> createTemplateRequest)	Creates a template either from a TemplateDefinition or from an existing Amazon QuickSight analysis or template.
default CreateTemplateResponse	createTemplate(CreateTemplateRequest createTemplateRequest)	Creates a template either from a TemplateDefinition or from an existing Amazon QuickSight analysis or template.
default CreateTemplateAliasResponse	createTemplateAlias(Consumer<CreateTemplateAliasRequest.Builder> createTemplateAliasRequest)	Creates a template alias for a template.
default CreateTemplateAliasResponse	createTemplateAlias(CreateTemplateAliasRequest createTemplateAliasRequest)	Creates a template alias for a template.
default CreateThemeResponse	createTheme(Consumer<CreateThemeRequest.Builder> createThemeRequest)	Creates a theme.
default CreateThemeResponse	createTheme(CreateThemeRequest createThemeRequest)	Creates a theme.
default CreateThemeAliasResponse	createThemeAlias(Consumer<CreateThemeAliasRequest.Builder> createThemeAliasRequest)	Creates a theme alias for a theme.
default CreateThemeAliasResponse	createThemeAlias(CreateThemeAliasRequest createThemeAliasRequest)	Creates a theme alias for a theme.
default CreateTopicResponse	createTopic(Consumer<CreateTopicRequest.Builder> createTopicRequest)	Creates a new Q topic.
default CreateTopicResponse	createTopic(CreateTopicRequest createTopicRequest)	Creates a new Q topic.
default CreateTopicRefreshScheduleResponse	createTopicRefreshSchedule(Consumer<CreateTopicRefreshScheduleRequest.Builder> createTopicRefreshScheduleRequest)	Creates a topic refresh schedule.
default CreateTopicRefreshScheduleResponse	createTopicRefreshSchedule(CreateTopicRefreshScheduleRequest createTopicRefreshScheduleRequest)	Creates a topic refresh schedule.
default CreateVpcConnectionResponse	createVPCConnection(Consumer<CreateVpcConnectionRequest.Builder> createVpcConnectionRequest)	Creates a new VPC connection.
default CreateVpcConnectionResponse	createVPCConnection(CreateVpcConnectionRequest createVpcConnectionRequest)	Creates a new VPC connection.
default DeleteAccountCustomizationResponse	deleteAccountCustomization(Consumer<DeleteAccountCustomizationRequest.Builder> deleteAccountCustomizationRequest)	Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.
default DeleteAccountCustomizationResponse	deleteAccountCustomization(DeleteAccountCustomizationRequest deleteAccountCustomizationRequest)	Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.
default DeleteAccountSubscriptionResponse	deleteAccountSubscription(Consumer<DeleteAccountSubscriptionRequest.Builder> deleteAccountSubscriptionRequest)	Use the DeleteAccountSubscription operation to delete an Amazon QuickSight account.
default DeleteAccountSubscriptionResponse	deleteAccountSubscription(DeleteAccountSubscriptionRequest deleteAccountSubscriptionRequest)	Use the DeleteAccountSubscription operation to delete an Amazon QuickSight account.
default DeleteAnalysisResponse	deleteAnalysis(Consumer<DeleteAnalysisRequest.Builder> deleteAnalysisRequest)	Deletes an analysis from Amazon QuickSight.
default DeleteAnalysisResponse	deleteAnalysis(DeleteAnalysisRequest deleteAnalysisRequest)	Deletes an analysis from Amazon QuickSight.
default DeleteDashboardResponse	deleteDashboard(Consumer<DeleteDashboardRequest.Builder> deleteDashboardRequest)	Deletes a dashboard.
default DeleteDashboardResponse	deleteDashboard(DeleteDashboardRequest deleteDashboardRequest)	Deletes a dashboard.
default DeleteDataSetResponse	deleteDataSet(Consumer<DeleteDataSetRequest.Builder> deleteDataSetRequest)	Deletes a dataset.
default DeleteDataSetResponse	deleteDataSet(DeleteDataSetRequest deleteDataSetRequest)	Deletes a dataset.
default DeleteDataSetRefreshPropertiesResponse	deleteDataSetRefreshProperties(Consumer<DeleteDataSetRefreshPropertiesRequest.Builder> deleteDataSetRefreshPropertiesRequest)	Deletes the dataset refresh properties of the dataset.
default DeleteDataSetRefreshPropertiesResponse	deleteDataSetRefreshProperties(DeleteDataSetRefreshPropertiesRequest deleteDataSetRefreshPropertiesRequest)	Deletes the dataset refresh properties of the dataset.
default DeleteDataSourceResponse	deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest)	Deletes the data source permanently.
default DeleteDataSourceResponse	deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)	Deletes the data source permanently.
default DeleteFolderResponse	deleteFolder(Consumer<DeleteFolderRequest.Builder> deleteFolderRequest)	Deletes an empty folder.
default DeleteFolderResponse	deleteFolder(DeleteFolderRequest deleteFolderRequest)	Deletes an empty folder.
default DeleteFolderMembershipResponse	deleteFolderMembership(Consumer<DeleteFolderMembershipRequest.Builder> deleteFolderMembershipRequest)	Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
default DeleteFolderMembershipResponse	deleteFolderMembership(DeleteFolderMembershipRequest deleteFolderMembershipRequest)	Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
default DeleteGroupResponse	deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)	Removes a user group from Amazon QuickSight.
default DeleteGroupResponse	deleteGroup(DeleteGroupRequest deleteGroupRequest)	Removes a user group from Amazon QuickSight.
default DeleteGroupMembershipResponse	deleteGroupMembership(Consumer<DeleteGroupMembershipRequest.Builder> deleteGroupMembershipRequest)	Removes a user from a group so that the user is no longer a member of the group.
default DeleteGroupMembershipResponse	deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest)	Removes a user from a group so that the user is no longer a member of the group.
default DeleteIamPolicyAssignmentResponse	deleteIAMPolicyAssignment(Consumer<DeleteIamPolicyAssignmentRequest.Builder> deleteIamPolicyAssignmentRequest)	Deletes an existing IAM policy assignment.
default DeleteIamPolicyAssignmentResponse	deleteIAMPolicyAssignment(DeleteIamPolicyAssignmentRequest deleteIamPolicyAssignmentRequest)	Deletes an existing IAM policy assignment.
default DeleteNamespaceResponse	deleteNamespace(Consumer<DeleteNamespaceRequest.Builder> deleteNamespaceRequest)	Deletes a namespace and the users and groups that are associated with the namespace.
default DeleteNamespaceResponse	deleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest)	Deletes a namespace and the users and groups that are associated with the namespace.
default DeleteRefreshScheduleResponse	deleteRefreshSchedule(Consumer<DeleteRefreshScheduleRequest.Builder> deleteRefreshScheduleRequest)	Deletes a refresh schedule from a dataset.
default DeleteRefreshScheduleResponse	deleteRefreshSchedule(DeleteRefreshScheduleRequest deleteRefreshScheduleRequest)	Deletes a refresh schedule from a dataset.
default DeleteTemplateResponse	deleteTemplate(Consumer<DeleteTemplateRequest.Builder> deleteTemplateRequest)	Deletes a template.
default DeleteTemplateResponse	deleteTemplate(DeleteTemplateRequest deleteTemplateRequest)	Deletes a template.
default DeleteTemplateAliasResponse	deleteTemplateAlias(Consumer<DeleteTemplateAliasRequest.Builder> deleteTemplateAliasRequest)	Deletes the item that the specified template alias points to.
default DeleteTemplateAliasResponse	deleteTemplateAlias(DeleteTemplateAliasRequest deleteTemplateAliasRequest)	Deletes the item that the specified template alias points to.
default DeleteThemeResponse	deleteTheme(Consumer<DeleteThemeRequest.Builder> deleteThemeRequest)	Deletes a theme.
default DeleteThemeResponse	deleteTheme(DeleteThemeRequest deleteThemeRequest)	Deletes a theme.
default DeleteThemeAliasResponse	deleteThemeAlias(Consumer<DeleteThemeAliasRequest.Builder> deleteThemeAliasRequest)	Deletes the version of the theme that the specified theme alias points to.
default DeleteThemeAliasResponse	deleteThemeAlias(DeleteThemeAliasRequest deleteThemeAliasRequest)	Deletes the version of the theme that the specified theme alias points to.
default DeleteTopicResponse	deleteTopic(Consumer<DeleteTopicRequest.Builder> deleteTopicRequest)	Deletes a topic.
default DeleteTopicResponse	deleteTopic(DeleteTopicRequest deleteTopicRequest)	Deletes a topic.
default DeleteTopicRefreshScheduleResponse	deleteTopicRefreshSchedule(Consumer<DeleteTopicRefreshScheduleRequest.Builder> deleteTopicRefreshScheduleRequest)	Deletes a topic refresh schedule.
default DeleteTopicRefreshScheduleResponse	deleteTopicRefreshSchedule(DeleteTopicRefreshScheduleRequest deleteTopicRefreshScheduleRequest)	Deletes a topic refresh schedule.
default DeleteUserResponse	deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)	Deletes the Amazon QuickSight user that is associated with the identity of the IAM user or role that's making the call.
default DeleteUserResponse	deleteUser(DeleteUserRequest deleteUserRequest)	Deletes the Amazon QuickSight user that is associated with the identity of the IAM user or role that's making the call.
default DeleteUserByPrincipalIdResponse	deleteUserByPrincipalId(Consumer<DeleteUserByPrincipalIdRequest.Builder> deleteUserByPrincipalIdRequest)	Deletes a user identified by its principal ID.
default DeleteUserByPrincipalIdResponse	deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest deleteUserByPrincipalIdRequest)	Deletes a user identified by its principal ID.
default DeleteVpcConnectionResponse	deleteVPCConnection(Consumer<DeleteVpcConnectionRequest.Builder> deleteVpcConnectionRequest)	Deletes a VPC connection.
default DeleteVpcConnectionResponse	deleteVPCConnection(DeleteVpcConnectionRequest deleteVpcConnectionRequest)	Deletes a VPC connection.
default DescribeAccountCustomizationResponse	describeAccountCustomization(Consumer<DescribeAccountCustomizationRequest.Builder> describeAccountCustomizationRequest)	Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region.
default DescribeAccountCustomizationResponse	describeAccountCustomization(DescribeAccountCustomizationRequest describeAccountCustomizationRequest)	Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region.
default DescribeAccountSettingsResponse	describeAccountSettings(Consumer<DescribeAccountSettingsRequest.Builder> describeAccountSettingsRequest)	Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
default DescribeAccountSettingsResponse	describeAccountSettings(DescribeAccountSettingsRequest describeAccountSettingsRequest)	Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
default DescribeAccountSubscriptionResponse	describeAccountSubscription(Consumer<DescribeAccountSubscriptionRequest.Builder> describeAccountSubscriptionRequest)	Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription.
default DescribeAccountSubscriptionResponse	describeAccountSubscription(DescribeAccountSubscriptionRequest describeAccountSubscriptionRequest)	Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription.
default DescribeAnalysisResponse	describeAnalysis(Consumer<DescribeAnalysisRequest.Builder> describeAnalysisRequest)	Provides a summary of the metadata for an analysis.
default DescribeAnalysisResponse	describeAnalysis(DescribeAnalysisRequest describeAnalysisRequest)	Provides a summary of the metadata for an analysis.
default DescribeAnalysisDefinitionResponse	describeAnalysisDefinition(Consumer<DescribeAnalysisDefinitionRequest.Builder> describeAnalysisDefinitionRequest)	Provides a detailed description of the definition of an analysis.
default DescribeAnalysisDefinitionResponse	describeAnalysisDefinition(DescribeAnalysisDefinitionRequest describeAnalysisDefinitionRequest)	Provides a detailed description of the definition of an analysis.
default DescribeAnalysisPermissionsResponse	describeAnalysisPermissions(Consumer<DescribeAnalysisPermissionsRequest.Builder> describeAnalysisPermissionsRequest)	Provides the read and write permissions for an analysis.
default DescribeAnalysisPermissionsResponse	describeAnalysisPermissions(DescribeAnalysisPermissionsRequest describeAnalysisPermissionsRequest)	Provides the read and write permissions for an analysis.
default DescribeAssetBundleExportJobResponse	describeAssetBundleExportJob(Consumer<DescribeAssetBundleExportJobRequest.Builder> describeAssetBundleExportJobRequest)	Describes an existing export job.
default DescribeAssetBundleExportJobResponse	describeAssetBundleExportJob(DescribeAssetBundleExportJobRequest describeAssetBundleExportJobRequest)	Describes an existing export job.
default DescribeAssetBundleImportJobResponse	describeAssetBundleImportJob(Consumer<DescribeAssetBundleImportJobRequest.Builder> describeAssetBundleImportJobRequest)	Describes an existing import job.
default DescribeAssetBundleImportJobResponse	describeAssetBundleImportJob(DescribeAssetBundleImportJobRequest describeAssetBundleImportJobRequest)	Describes an existing import job.
default DescribeDashboardResponse	describeDashboard(Consumer<DescribeDashboardRequest.Builder> describeDashboardRequest)	Provides a summary for a dashboard.
default DescribeDashboardResponse	describeDashboard(DescribeDashboardRequest describeDashboardRequest)	Provides a summary for a dashboard.
default DescribeDashboardDefinitionResponse	describeDashboardDefinition(Consumer<DescribeDashboardDefinitionRequest.Builder> describeDashboardDefinitionRequest)	Provides a detailed description of the definition of a dashboard.
default DescribeDashboardDefinitionResponse	describeDashboardDefinition(DescribeDashboardDefinitionRequest describeDashboardDefinitionRequest)	Provides a detailed description of the definition of a dashboard.
default DescribeDashboardPermissionsResponse	describeDashboardPermissions(Consumer<DescribeDashboardPermissionsRequest.Builder> describeDashboardPermissionsRequest)	Describes read and write permissions for a dashboard.
default DescribeDashboardPermissionsResponse	describeDashboardPermissions(DescribeDashboardPermissionsRequest describeDashboardPermissionsRequest)	Describes read and write permissions for a dashboard.
default DescribeDashboardSnapshotJobResponse	describeDashboardSnapshotJob(Consumer<DescribeDashboardSnapshotJobRequest.Builder> describeDashboardSnapshotJobRequest)	Describes an existing snapshot job.
default DescribeDashboardSnapshotJobResponse	describeDashboardSnapshotJob(DescribeDashboardSnapshotJobRequest describeDashboardSnapshotJobRequest)	Describes an existing snapshot job.
default DescribeDashboardSnapshotJobResultResponse	describeDashboardSnapshotJobResult(Consumer<DescribeDashboardSnapshotJobResultRequest.Builder> describeDashboardSnapshotJobResultRequest)	Describes the result of an existing snapshot job that has finished running.
default DescribeDashboardSnapshotJobResultResponse	describeDashboardSnapshotJobResult(DescribeDashboardSnapshotJobResultRequest describeDashboardSnapshotJobResultRequest)	Describes the result of an existing snapshot job that has finished running.
default DescribeDataSetResponse	describeDataSet(Consumer<DescribeDataSetRequest.Builder> describeDataSetRequest)	Describes a dataset.
default DescribeDataSetResponse	describeDataSet(DescribeDataSetRequest describeDataSetRequest)	Describes a dataset.
default DescribeDataSetPermissionsResponse	describeDataSetPermissions(Consumer<DescribeDataSetPermissionsRequest.Builder> describeDataSetPermissionsRequest)	Describes the permissions on a dataset.
default DescribeDataSetPermissionsResponse	describeDataSetPermissions(DescribeDataSetPermissionsRequest describeDataSetPermissionsRequest)	Describes the permissions on a dataset.
default DescribeDataSetRefreshPropertiesResponse	describeDataSetRefreshProperties(Consumer<DescribeDataSetRefreshPropertiesRequest.Builder> describeDataSetRefreshPropertiesRequest)	Describes the refresh properties of a dataset.
default DescribeDataSetRefreshPropertiesResponse	describeDataSetRefreshProperties(DescribeDataSetRefreshPropertiesRequest describeDataSetRefreshPropertiesRequest)	Describes the refresh properties of a dataset.
default DescribeDataSourceResponse	describeDataSource(Consumer<DescribeDataSourceRequest.Builder> describeDataSourceRequest)	Describes a data source.
default DescribeDataSourceResponse	describeDataSource(DescribeDataSourceRequest describeDataSourceRequest)	Describes a data source.
default DescribeDataSourcePermissionsResponse	describeDataSourcePermissions(Consumer<DescribeDataSourcePermissionsRequest.Builder> describeDataSourcePermissionsRequest)	Describes the resource permissions for a data source.
default DescribeDataSourcePermissionsResponse	describeDataSourcePermissions(DescribeDataSourcePermissionsRequest describeDataSourcePermissionsRequest)	Describes the resource permissions for a data source.
default DescribeFolderResponse	describeFolder(Consumer<DescribeFolderRequest.Builder> describeFolderRequest)	Describes a folder.
default DescribeFolderResponse	describeFolder(DescribeFolderRequest describeFolderRequest)	Describes a folder.
default DescribeFolderPermissionsResponse	describeFolderPermissions(Consumer<DescribeFolderPermissionsRequest.Builder> describeFolderPermissionsRequest)	Describes permissions for a folder.
default DescribeFolderPermissionsResponse	describeFolderPermissions(DescribeFolderPermissionsRequest describeFolderPermissionsRequest)	Describes permissions for a folder.
default DescribeFolderPermissionsIterable	describeFolderPermissionsPaginator(Consumer<DescribeFolderPermissionsRequest.Builder> describeFolderPermissionsRequest)	Describes permissions for a folder.
default DescribeFolderPermissionsIterable	describeFolderPermissionsPaginator(DescribeFolderPermissionsRequest describeFolderPermissionsRequest)	Describes permissions for a folder.
default DescribeFolderResolvedPermissionsResponse	describeFolderResolvedPermissions(Consumer<DescribeFolderResolvedPermissionsRequest.Builder> describeFolderResolvedPermissionsRequest)	Describes the folder resolved permissions.
default DescribeFolderResolvedPermissionsResponse	describeFolderResolvedPermissions(DescribeFolderResolvedPermissionsRequest describeFolderResolvedPermissionsRequest)	Describes the folder resolved permissions.
default DescribeFolderResolvedPermissionsIterable	describeFolderResolvedPermissionsPaginator(Consumer<DescribeFolderResolvedPermissionsRequest.Builder> describeFolderResolvedPermissionsRequest)	Describes the folder resolved permissions.
default DescribeFolderResolvedPermissionsIterable	describeFolderResolvedPermissionsPaginator(DescribeFolderResolvedPermissionsRequest describeFolderResolvedPermissionsRequest)	Describes the folder resolved permissions.
default DescribeGroupResponse	describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest)	Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
default DescribeGroupResponse	describeGroup(DescribeGroupRequest describeGroupRequest)	Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
default DescribeGroupMembershipResponse	describeGroupMembership(Consumer<DescribeGroupMembershipRequest.Builder> describeGroupMembershipRequest)	Use the DescribeGroupMembership operation to determine if a user is a member of the specified group.
default DescribeGroupMembershipResponse	describeGroupMembership(DescribeGroupMembershipRequest describeGroupMembershipRequest)	Use the DescribeGroupMembership operation to determine if a user is a member of the specified group.
default DescribeIamPolicyAssignmentResponse	describeIAMPolicyAssignment(Consumer<DescribeIamPolicyAssignmentRequest.Builder> describeIamPolicyAssignmentRequest)	Describes an existing IAM policy assignment, as specified by the assignment name.
default DescribeIamPolicyAssignmentResponse	describeIAMPolicyAssignment(DescribeIamPolicyAssignmentRequest describeIamPolicyAssignmentRequest)	Describes an existing IAM policy assignment, as specified by the assignment name.
default DescribeIngestionResponse	describeIngestion(Consumer<DescribeIngestionRequest.Builder> describeIngestionRequest)	Describes a SPICE ingestion.
default DescribeIngestionResponse	describeIngestion(DescribeIngestionRequest describeIngestionRequest)	Describes a SPICE ingestion.
default DescribeIpRestrictionResponse	describeIpRestriction(Consumer<DescribeIpRestrictionRequest.Builder> describeIpRestrictionRequest)	Provides a summary and status of IP rules.
default DescribeIpRestrictionResponse	describeIpRestriction(DescribeIpRestrictionRequest describeIpRestrictionRequest)	Provides a summary and status of IP rules.
default DescribeNamespaceResponse	describeNamespace(Consumer<DescribeNamespaceRequest.Builder> describeNamespaceRequest)	Describes the current namespace.
default DescribeNamespaceResponse	describeNamespace(DescribeNamespaceRequest describeNamespaceRequest)	Describes the current namespace.
default DescribeRefreshScheduleResponse	describeRefreshSchedule(Consumer<DescribeRefreshScheduleRequest.Builder> describeRefreshScheduleRequest)	Provides a summary of a refresh schedule.
default DescribeRefreshScheduleResponse	describeRefreshSchedule(DescribeRefreshScheduleRequest describeRefreshScheduleRequest)	Provides a summary of a refresh schedule.
default DescribeTemplateResponse	describeTemplate(Consumer<DescribeTemplateRequest.Builder> describeTemplateRequest)	Describes a template's metadata.
default DescribeTemplateResponse	describeTemplate(DescribeTemplateRequest describeTemplateRequest)	Describes a template's metadata.
default DescribeTemplateAliasResponse	describeTemplateAlias(Consumer<DescribeTemplateAliasRequest.Builder> describeTemplateAliasRequest)	Describes the template alias for a template.
default DescribeTemplateAliasResponse	describeTemplateAlias(DescribeTemplateAliasRequest describeTemplateAliasRequest)	Describes the template alias for a template.
default DescribeTemplateDefinitionResponse	describeTemplateDefinition(Consumer<DescribeTemplateDefinitionRequest.Builder> describeTemplateDefinitionRequest)	Provides a detailed description of the definition of a template.
default DescribeTemplateDefinitionResponse	describeTemplateDefinition(DescribeTemplateDefinitionRequest describeTemplateDefinitionRequest)	Provides a detailed description of the definition of a template.
default DescribeTemplatePermissionsResponse	describeTemplatePermissions(Consumer<DescribeTemplatePermissionsRequest.Builder> describeTemplatePermissionsRequest)	Describes read and write permissions on a template.
default DescribeTemplatePermissionsResponse	describeTemplatePermissions(DescribeTemplatePermissionsRequest describeTemplatePermissionsRequest)	Describes read and write permissions on a template.
default DescribeThemeResponse	describeTheme(Consumer<DescribeThemeRequest.Builder> describeThemeRequest)	Describes a theme.
default DescribeThemeResponse	describeTheme(DescribeThemeRequest describeThemeRequest)	Describes a theme.
default DescribeThemeAliasResponse	describeThemeAlias(Consumer<DescribeThemeAliasRequest.Builder> describeThemeAliasRequest)	Describes the alias for a theme.
default DescribeThemeAliasResponse	describeThemeAlias(DescribeThemeAliasRequest describeThemeAliasRequest)	Describes the alias for a theme.
default DescribeThemePermissionsResponse	describeThemePermissions(Consumer<DescribeThemePermissionsRequest.Builder> describeThemePermissionsRequest)	Describes the read and write permissions for a theme.
default DescribeThemePermissionsResponse	describeThemePermissions(DescribeThemePermissionsRequest describeThemePermissionsRequest)	Describes the read and write permissions for a theme.
default DescribeTopicResponse	describeTopic(Consumer<DescribeTopicRequest.Builder> describeTopicRequest)	Describes a topic.
default DescribeTopicResponse	describeTopic(DescribeTopicRequest describeTopicRequest)	Describes a topic.
default DescribeTopicPermissionsResponse	describeTopicPermissions(Consumer<DescribeTopicPermissionsRequest.Builder> describeTopicPermissionsRequest)	Describes the permissions of a topic.
default DescribeTopicPermissionsResponse	describeTopicPermissions(DescribeTopicPermissionsRequest describeTopicPermissionsRequest)	Describes the permissions of a topic.
default DescribeTopicRefreshResponse	describeTopicRefresh(Consumer<DescribeTopicRefreshRequest.Builder> describeTopicRefreshRequest)	Describes the status of a topic refresh.
default DescribeTopicRefreshResponse	describeTopicRefresh(DescribeTopicRefreshRequest describeTopicRefreshRequest)	Describes the status of a topic refresh.
default DescribeTopicRefreshScheduleResponse	describeTopicRefreshSchedule(Consumer<DescribeTopicRefreshScheduleRequest.Builder> describeTopicRefreshScheduleRequest)	Deletes a topic refresh schedule.
default DescribeTopicRefreshScheduleResponse	describeTopicRefreshSchedule(DescribeTopicRefreshScheduleRequest describeTopicRefreshScheduleRequest)	Deletes a topic refresh schedule.
default DescribeUserResponse	describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)	Returns information about a user, given the user name.
default DescribeUserResponse	describeUser(DescribeUserRequest describeUserRequest)	Returns information about a user, given the user name.
default DescribeVpcConnectionResponse	describeVPCConnection(Consumer<DescribeVpcConnectionRequest.Builder> describeVpcConnectionRequest)	Describes a VPC connection.
default DescribeVpcConnectionResponse	describeVPCConnection(DescribeVpcConnectionRequest describeVpcConnectionRequest)	Describes a VPC connection.
default 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.
default 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.
default GenerateEmbedUrlForRegisteredUserResponse	generateEmbedUrlForRegisteredUser(Consumer<GenerateEmbedUrlForRegisteredUserRequest.Builder> generateEmbedUrlForRegisteredUserRequest)	Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website.
default GenerateEmbedUrlForRegisteredUserResponse	generateEmbedUrlForRegisteredUser(GenerateEmbedUrlForRegisteredUserRequest generateEmbedUrlForRegisteredUserRequest)	Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website.
default GetDashboardEmbedUrlResponse	getDashboardEmbedUrl(Consumer<GetDashboardEmbedUrlRequest.Builder> getDashboardEmbedUrlRequest)	Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application.
default GetDashboardEmbedUrlResponse	getDashboardEmbedUrl(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest)	Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application.
default GetSessionEmbedUrlResponse	getSessionEmbedUrl(Consumer<GetSessionEmbedUrlRequest.Builder> getSessionEmbedUrlRequest)	Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in your web server code.
default GetSessionEmbedUrlResponse	getSessionEmbedUrl(GetSessionEmbedUrlRequest getSessionEmbedUrlRequest)	Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in your web server code.
default ListAnalysesResponse	listAnalyses(Consumer<ListAnalysesRequest.Builder> listAnalysesRequest)	Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
default ListAnalysesResponse	listAnalyses(ListAnalysesRequest listAnalysesRequest)	Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
default ListAnalysesIterable	listAnalysesPaginator(Consumer<ListAnalysesRequest.Builder> listAnalysesRequest)	Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
default ListAnalysesIterable	listAnalysesPaginator(ListAnalysesRequest listAnalysesRequest)	Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
default ListAssetBundleExportJobsResponse	listAssetBundleExportJobs(Consumer<ListAssetBundleExportJobsRequest.Builder> listAssetBundleExportJobsRequest)	Lists all asset bundle export jobs that have been taken place in the last 14 days.
default ListAssetBundleExportJobsResponse	listAssetBundleExportJobs(ListAssetBundleExportJobsRequest listAssetBundleExportJobsRequest)	Lists all asset bundle export jobs that have been taken place in the last 14 days.
default ListAssetBundleExportJobsIterable	listAssetBundleExportJobsPaginator(Consumer<ListAssetBundleExportJobsRequest.Builder> listAssetBundleExportJobsRequest)	Lists all asset bundle export jobs that have been taken place in the last 14 days.
default ListAssetBundleExportJobsIterable	listAssetBundleExportJobsPaginator(ListAssetBundleExportJobsRequest listAssetBundleExportJobsRequest)	Lists all asset bundle export jobs that have been taken place in the last 14 days.
default ListAssetBundleImportJobsResponse	listAssetBundleImportJobs(Consumer<ListAssetBundleImportJobsRequest.Builder> listAssetBundleImportJobsRequest)	Lists all asset bundle import jobs that have taken place in the last 14 days.
default ListAssetBundleImportJobsResponse	listAssetBundleImportJobs(ListAssetBundleImportJobsRequest listAssetBundleImportJobsRequest)	Lists all asset bundle import jobs that have taken place in the last 14 days.
default ListAssetBundleImportJobsIterable	listAssetBundleImportJobsPaginator(Consumer<ListAssetBundleImportJobsRequest.Builder> listAssetBundleImportJobsRequest)	Lists all asset bundle import jobs that have taken place in the last 14 days.
default ListAssetBundleImportJobsIterable	listAssetBundleImportJobsPaginator(ListAssetBundleImportJobsRequest listAssetBundleImportJobsRequest)	Lists all asset bundle import jobs that have taken place in the last 14 days.
default ListDashboardsResponse	listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)	Lists dashboards in an Amazon Web Services account.
default ListDashboardsResponse	listDashboards(ListDashboardsRequest listDashboardsRequest)	Lists dashboards in an Amazon Web Services account.
default ListDashboardsIterable	listDashboardsPaginator(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)	Lists dashboards in an Amazon Web Services account.
default ListDashboardsIterable	listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest)	Lists dashboards in an Amazon Web Services account.
default ListDashboardVersionsResponse	listDashboardVersions(Consumer<ListDashboardVersionsRequest.Builder> listDashboardVersionsRequest)	Lists all the versions of the dashboards in the Amazon QuickSight subscription.
default ListDashboardVersionsResponse	listDashboardVersions(ListDashboardVersionsRequest listDashboardVersionsRequest)	Lists all the versions of the dashboards in the Amazon QuickSight subscription.
default ListDashboardVersionsIterable	listDashboardVersionsPaginator(Consumer<ListDashboardVersionsRequest.Builder> listDashboardVersionsRequest)	Lists all the versions of the dashboards in the Amazon QuickSight subscription.
default ListDashboardVersionsIterable	listDashboardVersionsPaginator(ListDashboardVersionsRequest listDashboardVersionsRequest)	Lists all the versions of the dashboards in the Amazon QuickSight subscription.
default 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 ListDataSetsResponse	listDataSets(ListDataSetsRequest listDataSetsRequest)	Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
default ListDataSetsIterable	listDataSetsPaginator(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest)	Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
default ListDataSetsIterable	listDataSetsPaginator(ListDataSetsRequest listDataSetsRequest)	Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
default ListDataSourcesResponse	listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)	Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
default ListDataSourcesResponse	listDataSources(ListDataSourcesRequest listDataSourcesRequest)	Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
default ListDataSourcesIterable	listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)	Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
default ListDataSourcesIterable	listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest)	Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
default ListFolderMembersResponse	listFolderMembers(Consumer<ListFolderMembersRequest.Builder> listFolderMembersRequest)	List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.
default ListFolderMembersResponse	listFolderMembers(ListFolderMembersRequest listFolderMembersRequest)	List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.
default ListFolderMembersIterable	listFolderMembersPaginator(Consumer<ListFolderMembersRequest.Builder> listFolderMembersRequest)	List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.
default ListFolderMembersIterable	listFolderMembersPaginator(ListFolderMembersRequest listFolderMembersRequest)	List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.
default ListFoldersResponse	listFolders(Consumer<ListFoldersRequest.Builder> listFoldersRequest)	Lists all folders in an account.
default ListFoldersResponse	listFolders(ListFoldersRequest listFoldersRequest)	Lists all folders in an account.
default ListFoldersIterable	listFoldersPaginator(Consumer<ListFoldersRequest.Builder> listFoldersRequest)	Lists all folders in an account.
default ListFoldersIterable	listFoldersPaginator(ListFoldersRequest listFoldersRequest)	Lists all folders in an account.
default ListGroupMembershipsResponse	listGroupMemberships(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest)	Lists member users in a group.
default ListGroupMembershipsResponse	listGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest)	Lists member users in a group.
default ListGroupMembershipsIterable	listGroupMembershipsPaginator(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest)	Lists member users in a group.
default ListGroupMembershipsIterable	listGroupMembershipsPaginator(ListGroupMembershipsRequest listGroupMembershipsRequest)	Lists member users in a group.
default ListGroupsResponse	listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)	Lists all user groups in Amazon QuickSight.
default ListGroupsResponse	listGroups(ListGroupsRequest listGroupsRequest)	Lists all user groups in Amazon QuickSight.
default ListGroupsIterable	listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)	Lists all user groups in Amazon QuickSight.
default ListGroupsIterable	listGroupsPaginator(ListGroupsRequest listGroupsRequest)	Lists all user groups in Amazon QuickSight.
default ListIamPolicyAssignmentsResponse	listIAMPolicyAssignments(Consumer<ListIamPolicyAssignmentsRequest.Builder> listIamPolicyAssignmentsRequest)	Lists the IAM policy assignments in the current Amazon QuickSight account.
default ListIamPolicyAssignmentsResponse	listIAMPolicyAssignments(ListIamPolicyAssignmentsRequest listIamPolicyAssignmentsRequest)	Lists the IAM policy assignments in the current Amazon QuickSight account.
default 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.
default 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.
default ListIAMPolicyAssignmentsForUserIterable	listIAMPolicyAssignmentsForUserPaginator(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.
default ListIAMPolicyAssignmentsForUserIterable	listIAMPolicyAssignmentsForUserPaginator(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.
default ListIAMPolicyAssignmentsIterable	listIAMPolicyAssignmentsPaginator(Consumer<ListIamPolicyAssignmentsRequest.Builder> listIamPolicyAssignmentsRequest)	Lists the IAM policy assignments in the current Amazon QuickSight account.
default ListIAMPolicyAssignmentsIterable	listIAMPolicyAssignmentsPaginator(ListIamPolicyAssignmentsRequest listIamPolicyAssignmentsRequest)	Lists the IAM policy assignments in the current Amazon QuickSight account.
default ListIngestionsResponse	listIngestions(Consumer<ListIngestionsRequest.Builder> listIngestionsRequest)	Lists the history of SPICE ingestions for a dataset.
default ListIngestionsResponse	listIngestions(ListIngestionsRequest listIngestionsRequest)	Lists the history of SPICE ingestions for a dataset.
default ListIngestionsIterable	listIngestionsPaginator(Consumer<ListIngestionsRequest.Builder> listIngestionsRequest)	Lists the history of SPICE ingestions for a dataset.
default ListIngestionsIterable	listIngestionsPaginator(ListIngestionsRequest listIngestionsRequest)	Lists the history of SPICE ingestions for a dataset.
default ListNamespacesResponse	listNamespaces(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest)	Lists the namespaces for the specified Amazon Web Services account.
default ListNamespacesResponse	listNamespaces(ListNamespacesRequest listNamespacesRequest)	Lists the namespaces for the specified Amazon Web Services account.
default ListNamespacesIterable	listNamespacesPaginator(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest)	Lists the namespaces for the specified Amazon Web Services account.
default ListNamespacesIterable	listNamespacesPaginator(ListNamespacesRequest listNamespacesRequest)	Lists the namespaces for the specified Amazon Web Services account.
default ListRefreshSchedulesResponse	listRefreshSchedules(Consumer<ListRefreshSchedulesRequest.Builder> listRefreshSchedulesRequest)	Lists the refresh schedules of a dataset.
default ListRefreshSchedulesResponse	listRefreshSchedules(ListRefreshSchedulesRequest listRefreshSchedulesRequest)	Lists the refresh schedules of a dataset.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists the tags assigned to a resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists the tags assigned to a resource.
default ListTemplateAliasesResponse	listTemplateAliases(Consumer<ListTemplateAliasesRequest.Builder> listTemplateAliasesRequest)	Lists all the aliases of a template.
default ListTemplateAliasesResponse	listTemplateAliases(ListTemplateAliasesRequest listTemplateAliasesRequest)	Lists all the aliases of a template.
default ListTemplateAliasesIterable	listTemplateAliasesPaginator(Consumer<ListTemplateAliasesRequest.Builder> listTemplateAliasesRequest)	Lists all the aliases of a template.
default ListTemplateAliasesIterable	listTemplateAliasesPaginator(ListTemplateAliasesRequest listTemplateAliasesRequest)	Lists all the aliases of a template.
default ListTemplatesResponse	listTemplates(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest)	Lists all the templates in the current Amazon QuickSight account.
default ListTemplatesResponse	listTemplates(ListTemplatesRequest listTemplatesRequest)	Lists all the templates in the current Amazon QuickSight account.
default ListTemplatesIterable	listTemplatesPaginator(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest)	Lists all the templates in the current Amazon QuickSight account.
default ListTemplatesIterable	listTemplatesPaginator(ListTemplatesRequest listTemplatesRequest)	Lists all the templates in the current Amazon QuickSight account.
default ListTemplateVersionsResponse	listTemplateVersions(Consumer<ListTemplateVersionsRequest.Builder> listTemplateVersionsRequest)	Lists all the versions of the templates in the current Amazon QuickSight account.
default ListTemplateVersionsResponse	listTemplateVersions(ListTemplateVersionsRequest listTemplateVersionsRequest)	Lists all the versions of the templates in the current Amazon QuickSight account.
default ListTemplateVersionsIterable	listTemplateVersionsPaginator(Consumer<ListTemplateVersionsRequest.Builder> listTemplateVersionsRequest)	Lists all the versions of the templates in the current Amazon QuickSight account.
default ListTemplateVersionsIterable	listTemplateVersionsPaginator(ListTemplateVersionsRequest listTemplateVersionsRequest)	Lists all the versions of the templates in the current Amazon QuickSight account.
default ListThemeAliasesResponse	listThemeAliases(Consumer<ListThemeAliasesRequest.Builder> listThemeAliasesRequest)	Lists all the aliases of a theme.
default ListThemeAliasesResponse	listThemeAliases(ListThemeAliasesRequest listThemeAliasesRequest)	Lists all the aliases of a theme.
default ListThemesResponse	listThemes(Consumer<ListThemesRequest.Builder> listThemesRequest)	Lists all the themes in the current Amazon Web Services account.
default ListThemesResponse	listThemes(ListThemesRequest listThemesRequest)	Lists all the themes in the current Amazon Web Services account.
default ListThemesIterable	listThemesPaginator(Consumer<ListThemesRequest.Builder> listThemesRequest)	Lists all the themes in the current Amazon Web Services account.
default ListThemesIterable	listThemesPaginator(ListThemesRequest listThemesRequest)	Lists all the themes in the current Amazon Web Services account.
default ListThemeVersionsResponse	listThemeVersions(Consumer<ListThemeVersionsRequest.Builder> listThemeVersionsRequest)	Lists all the versions of the themes in the current Amazon Web Services account.
default ListThemeVersionsResponse	listThemeVersions(ListThemeVersionsRequest listThemeVersionsRequest)	Lists all the versions of the themes in the current Amazon Web Services account.
default ListThemeVersionsIterable	listThemeVersionsPaginator(Consumer<ListThemeVersionsRequest.Builder> listThemeVersionsRequest)	Lists all the versions of the themes in the current Amazon Web Services account.
default ListThemeVersionsIterable	listThemeVersionsPaginator(ListThemeVersionsRequest listThemeVersionsRequest)	Lists all the versions of the themes in the current Amazon Web Services account.
default ListTopicRefreshSchedulesResponse	listTopicRefreshSchedules(Consumer<ListTopicRefreshSchedulesRequest.Builder> listTopicRefreshSchedulesRequest)	Lists all of the refresh schedules for a topic.
default ListTopicRefreshSchedulesResponse	listTopicRefreshSchedules(ListTopicRefreshSchedulesRequest listTopicRefreshSchedulesRequest)	Lists all of the refresh schedules for a topic.
default ListTopicsResponse	listTopics(Consumer<ListTopicsRequest.Builder> listTopicsRequest)	Lists all of the topics within an account.
default ListTopicsResponse	listTopics(ListTopicsRequest listTopicsRequest)	Lists all of the topics within an account.
default ListTopicsIterable	listTopicsPaginator(Consumer<ListTopicsRequest.Builder> listTopicsRequest)	Lists all of the topics within an account.
default ListTopicsIterable	listTopicsPaginator(ListTopicsRequest listTopicsRequest)	Lists all of the topics within an account.
default ListUserGroupsResponse	listUserGroups(Consumer<ListUserGroupsRequest.Builder> listUserGroupsRequest)	Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
default ListUserGroupsResponse	listUserGroups(ListUserGroupsRequest listUserGroupsRequest)	Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
default ListUserGroupsIterable	listUserGroupsPaginator(Consumer<ListUserGroupsRequest.Builder> listUserGroupsRequest)	Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
default ListUserGroupsIterable	listUserGroupsPaginator(ListUserGroupsRequest listUserGroupsRequest)	Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
default ListUsersResponse	listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)	Returns a list of all of the Amazon QuickSight users belonging to this account.
default ListUsersResponse	listUsers(ListUsersRequest listUsersRequest)	Returns a list of all of the Amazon QuickSight users belonging to this account.
default ListUsersIterable	listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)	Returns a list of all of the Amazon QuickSight users belonging to this account.
default ListUsersIterable	listUsersPaginator(ListUsersRequest listUsersRequest)	Returns a list of all of the Amazon QuickSight users belonging to this account.
default 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.
default ListVpcConnectionsResponse	listVPCConnections(ListVpcConnectionsRequest listVpcConnectionsRequest)	Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
default ListVPCConnectionsIterable	listVPCConnectionsPaginator(Consumer<ListVpcConnectionsRequest.Builder> listVpcConnectionsRequest)	Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
default ListVPCConnectionsIterable	listVPCConnectionsPaginator(ListVpcConnectionsRequest listVpcConnectionsRequest)	Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
default PutDataSetRefreshPropertiesResponse	putDataSetRefreshProperties(Consumer<PutDataSetRefreshPropertiesRequest.Builder> putDataSetRefreshPropertiesRequest)	Creates or updates the dataset refresh properties for the dataset.
default PutDataSetRefreshPropertiesResponse	putDataSetRefreshProperties(PutDataSetRefreshPropertiesRequest putDataSetRefreshPropertiesRequest)	Creates or updates the dataset refresh properties for the dataset.
default RegisterUserResponse	registerUser(Consumer<RegisterUserRequest.Builder> registerUserRequest)	Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request.
default RegisterUserResponse	registerUser(RegisterUserRequest registerUserRequest)	Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request.
default RestoreAnalysisResponse	restoreAnalysis(Consumer<RestoreAnalysisRequest.Builder> restoreAnalysisRequest)	Restores an analysis.
default RestoreAnalysisResponse	restoreAnalysis(RestoreAnalysisRequest restoreAnalysisRequest)	Restores an analysis.
default SearchAnalysesResponse	searchAnalyses(Consumer<SearchAnalysesRequest.Builder> searchAnalysesRequest)	Searches for analyses that belong to the user specified in the filter.
default SearchAnalysesResponse	searchAnalyses(SearchAnalysesRequest searchAnalysesRequest)	Searches for analyses that belong to the user specified in the filter.
default SearchAnalysesIterable	searchAnalysesPaginator(Consumer<SearchAnalysesRequest.Builder> searchAnalysesRequest)	Searches for analyses that belong to the user specified in the filter.
default SearchAnalysesIterable	searchAnalysesPaginator(SearchAnalysesRequest searchAnalysesRequest)	Searches for analyses that belong to the user specified in the filter.
default SearchDashboardsResponse	searchDashboards(Consumer<SearchDashboardsRequest.Builder> searchDashboardsRequest)	Searches for dashboards that belong to a user.
default SearchDashboardsResponse	searchDashboards(SearchDashboardsRequest searchDashboardsRequest)	Searches for dashboards that belong to a user.
default SearchDashboardsIterable	searchDashboardsPaginator(Consumer<SearchDashboardsRequest.Builder> searchDashboardsRequest)	Searches for dashboards that belong to a user.
default SearchDashboardsIterable	searchDashboardsPaginator(SearchDashboardsRequest searchDashboardsRequest)	Searches for dashboards that belong to a user.
default SearchDataSetsResponse	searchDataSets(Consumer<SearchDataSetsRequest.Builder> searchDataSetsRequest)	Use the SearchDataSets operation to search for datasets that belong to an account.
default SearchDataSetsResponse	searchDataSets(SearchDataSetsRequest searchDataSetsRequest)	Use the SearchDataSets operation to search for datasets that belong to an account.
default SearchDataSetsIterable	searchDataSetsPaginator(Consumer<SearchDataSetsRequest.Builder> searchDataSetsRequest)	Use the SearchDataSets operation to search for datasets that belong to an account.
default SearchDataSetsIterable	searchDataSetsPaginator(SearchDataSetsRequest searchDataSetsRequest)	Use the SearchDataSets operation to search for datasets that belong to an account.
default SearchDataSourcesResponse	searchDataSources(Consumer<SearchDataSourcesRequest.Builder> searchDataSourcesRequest)	Use the SearchDataSources operation to search for data sources that belong to an account.
default SearchDataSourcesResponse	searchDataSources(SearchDataSourcesRequest searchDataSourcesRequest)	Use the SearchDataSources operation to search for data sources that belong to an account.
default SearchDataSourcesIterable	searchDataSourcesPaginator(Consumer<SearchDataSourcesRequest.Builder> searchDataSourcesRequest)	Use the SearchDataSources operation to search for data sources that belong to an account.
default SearchDataSourcesIterable	searchDataSourcesPaginator(SearchDataSourcesRequest searchDataSourcesRequest)	Use the SearchDataSources operation to search for data sources that belong to an account.
default SearchFoldersResponse	searchFolders(Consumer<SearchFoldersRequest.Builder> searchFoldersRequest)	Searches the subfolders in a folder.
default SearchFoldersResponse	searchFolders(SearchFoldersRequest searchFoldersRequest)	Searches the subfolders in a folder.
default SearchFoldersIterable	searchFoldersPaginator(Consumer<SearchFoldersRequest.Builder> searchFoldersRequest)	Searches the subfolders in a folder.
default SearchFoldersIterable	searchFoldersPaginator(SearchFoldersRequest searchFoldersRequest)	Searches the subfolders in a folder.
default SearchGroupsResponse	searchGroups(Consumer<SearchGroupsRequest.Builder> searchGroupsRequest)	Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.
default SearchGroupsResponse	searchGroups(SearchGroupsRequest searchGroupsRequest)	Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.
default SearchGroupsIterable	searchGroupsPaginator(Consumer<SearchGroupsRequest.Builder> searchGroupsRequest)	Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.
default SearchGroupsIterable	searchGroupsPaginator(SearchGroupsRequest searchGroupsRequest)	Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.
default QuickSightServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartAssetBundleExportJobResponse	startAssetBundleExportJob(Consumer<StartAssetBundleExportJobRequest.Builder> startAssetBundleExportJobRequest)	Starts an Asset Bundle export job.
default StartAssetBundleExportJobResponse	startAssetBundleExportJob(StartAssetBundleExportJobRequest startAssetBundleExportJobRequest)	Starts an Asset Bundle export job.
default StartAssetBundleImportJobResponse	startAssetBundleImportJob(Consumer<StartAssetBundleImportJobRequest.Builder> startAssetBundleImportJobRequest)	Starts an Asset Bundle import job.
default StartAssetBundleImportJobResponse	startAssetBundleImportJob(StartAssetBundleImportJobRequest startAssetBundleImportJobRequest)	Starts an Asset Bundle import job.
default StartDashboardSnapshotJobResponse	startDashboardSnapshotJob(Consumer<StartDashboardSnapshotJobRequest.Builder> startDashboardSnapshotJobRequest)	Starts an asynchronous job that generates a dashboard snapshot.
default StartDashboardSnapshotJobResponse	startDashboardSnapshotJob(StartDashboardSnapshotJobRequest startDashboardSnapshotJobRequest)	Starts an asynchronous job that generates a dashboard snapshot.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes a tag or tags from a resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes a tag or tags from a resource.
default UpdateAccountCustomizationResponse	updateAccountCustomization(Consumer<UpdateAccountCustomizationRequest.Builder> updateAccountCustomizationRequest)	Updates Amazon QuickSight customizations for the current Amazon Web Services Region.
default UpdateAccountCustomizationResponse	updateAccountCustomization(UpdateAccountCustomizationRequest updateAccountCustomizationRequest)	Updates Amazon QuickSight customizations for the current Amazon Web Services Region.
default UpdateAccountSettingsResponse	updateAccountSettings(Consumer<UpdateAccountSettingsRequest.Builder> updateAccountSettingsRequest)	Updates the Amazon QuickSight settings in your Amazon Web Services account.
default UpdateAccountSettingsResponse	updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest)	Updates the Amazon QuickSight settings in your Amazon Web Services account.
default UpdateAnalysisResponse	updateAnalysis(Consumer<UpdateAnalysisRequest.Builder> updateAnalysisRequest)	Updates an analysis in Amazon QuickSight
default UpdateAnalysisResponse	updateAnalysis(UpdateAnalysisRequest updateAnalysisRequest)	Updates an analysis in Amazon QuickSight
default UpdateAnalysisPermissionsResponse	updateAnalysisPermissions(Consumer<UpdateAnalysisPermissionsRequest.Builder> updateAnalysisPermissionsRequest)	Updates the read and write permissions for an analysis.
default UpdateAnalysisPermissionsResponse	updateAnalysisPermissions(UpdateAnalysisPermissionsRequest updateAnalysisPermissionsRequest)	Updates the read and write permissions for an analysis.
default UpdateDashboardResponse	updateDashboard(Consumer<UpdateDashboardRequest.Builder> updateDashboardRequest)	Updates a dashboard in an Amazon Web Services account.
default UpdateDashboardResponse	updateDashboard(UpdateDashboardRequest updateDashboardRequest)	Updates a dashboard in an Amazon Web Services account.
default UpdateDashboardPermissionsResponse	updateDashboardPermissions(Consumer<UpdateDashboardPermissionsRequest.Builder> updateDashboardPermissionsRequest)	Updates read and write permissions on a dashboard.
default UpdateDashboardPermissionsResponse	updateDashboardPermissions(UpdateDashboardPermissionsRequest updateDashboardPermissionsRequest)	Updates read and write permissions on a dashboard.
default UpdateDashboardPublishedVersionResponse	updateDashboardPublishedVersion(Consumer<UpdateDashboardPublishedVersionRequest.Builder> updateDashboardPublishedVersionRequest)	Updates the published version of a dashboard.
default UpdateDashboardPublishedVersionResponse	updateDashboardPublishedVersion(UpdateDashboardPublishedVersionRequest updateDashboardPublishedVersionRequest)	Updates the published version of a dashboard.
default UpdateDataSetResponse	updateDataSet(Consumer<UpdateDataSetRequest.Builder> updateDataSetRequest)	Updates a dataset.
default UpdateDataSetResponse	updateDataSet(UpdateDataSetRequest updateDataSetRequest)	Updates a dataset.
default UpdateDataSetPermissionsResponse	updateDataSetPermissions(Consumer<UpdateDataSetPermissionsRequest.Builder> updateDataSetPermissionsRequest)	Updates the permissions on a dataset.
default UpdateDataSetPermissionsResponse	updateDataSetPermissions(UpdateDataSetPermissionsRequest updateDataSetPermissionsRequest)	Updates the permissions on a dataset.
default UpdateDataSourceResponse	updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest)	Updates a data source.
default UpdateDataSourceResponse	updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)	Updates a data source.
default UpdateDataSourcePermissionsResponse	updateDataSourcePermissions(Consumer<UpdateDataSourcePermissionsRequest.Builder> updateDataSourcePermissionsRequest)	Updates the permissions to a data source.
default UpdateDataSourcePermissionsResponse	updateDataSourcePermissions(UpdateDataSourcePermissionsRequest updateDataSourcePermissionsRequest)	Updates the permissions to a data source.
default UpdateFolderResponse	updateFolder(Consumer<UpdateFolderRequest.Builder> updateFolderRequest)	Updates the name of a folder.
default UpdateFolderResponse	updateFolder(UpdateFolderRequest updateFolderRequest)	Updates the name of a folder.
default UpdateFolderPermissionsResponse	updateFolderPermissions(Consumer<UpdateFolderPermissionsRequest.Builder> updateFolderPermissionsRequest)	Updates permissions of a folder.
default UpdateFolderPermissionsResponse	updateFolderPermissions(UpdateFolderPermissionsRequest updateFolderPermissionsRequest)	Updates permissions of a folder.
default UpdateGroupResponse	updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)	Changes a group description.
default UpdateGroupResponse	updateGroup(UpdateGroupRequest updateGroupRequest)	Changes a group description.
default UpdateIamPolicyAssignmentResponse	updateIAMPolicyAssignment(Consumer<UpdateIamPolicyAssignmentRequest.Builder> updateIamPolicyAssignmentRequest)	Updates an existing IAM policy assignment.
default UpdateIamPolicyAssignmentResponse	updateIAMPolicyAssignment(UpdateIamPolicyAssignmentRequest updateIamPolicyAssignmentRequest)	Updates an existing IAM policy assignment.
default UpdateIpRestrictionResponse	updateIpRestriction(Consumer<UpdateIpRestrictionRequest.Builder> updateIpRestrictionRequest)	Updates the content and status of IP rules.
default UpdateIpRestrictionResponse	updateIpRestriction(UpdateIpRestrictionRequest updateIpRestrictionRequest)	Updates the content and status of IP rules.
default UpdatePublicSharingSettingsResponse	updatePublicSharingSettings(Consumer<UpdatePublicSharingSettingsRequest.Builder> updatePublicSharingSettingsRequest)	Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard.
default UpdatePublicSharingSettingsResponse	updatePublicSharingSettings(UpdatePublicSharingSettingsRequest updatePublicSharingSettingsRequest)	Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard.
default UpdateRefreshScheduleResponse	updateRefreshSchedule(Consumer<UpdateRefreshScheduleRequest.Builder> updateRefreshScheduleRequest)	Updates a refresh schedule for a dataset.
default UpdateRefreshScheduleResponse	updateRefreshSchedule(UpdateRefreshScheduleRequest updateRefreshScheduleRequest)	Updates a refresh schedule for a dataset.
default UpdateTemplateResponse	updateTemplate(Consumer<UpdateTemplateRequest.Builder> updateTemplateRequest)	Updates a template from an existing Amazon QuickSight analysis or another template.
default UpdateTemplateResponse	updateTemplate(UpdateTemplateRequest updateTemplateRequest)	Updates a template from an existing Amazon QuickSight analysis or another template.
default UpdateTemplateAliasResponse	updateTemplateAlias(Consumer<UpdateTemplateAliasRequest.Builder> updateTemplateAliasRequest)	Updates the template alias of a template.
default UpdateTemplateAliasResponse	updateTemplateAlias(UpdateTemplateAliasRequest updateTemplateAliasRequest)	Updates the template alias of a template.
default UpdateTemplatePermissionsResponse	updateTemplatePermissions(Consumer<UpdateTemplatePermissionsRequest.Builder> updateTemplatePermissionsRequest)	Updates the resource permissions for a template.
default UpdateTemplatePermissionsResponse	updateTemplatePermissions(UpdateTemplatePermissionsRequest updateTemplatePermissionsRequest)	Updates the resource permissions for a template.
default UpdateThemeResponse	updateTheme(Consumer<UpdateThemeRequest.Builder> updateThemeRequest)	Updates a theme.
default UpdateThemeResponse	updateTheme(UpdateThemeRequest updateThemeRequest)	Updates a theme.
default UpdateThemeAliasResponse	updateThemeAlias(Consumer<UpdateThemeAliasRequest.Builder> updateThemeAliasRequest)	Updates an alias of a theme.
default UpdateThemeAliasResponse	updateThemeAlias(UpdateThemeAliasRequest updateThemeAliasRequest)	Updates an alias of a theme.
default UpdateThemePermissionsResponse	updateThemePermissions(Consumer<UpdateThemePermissionsRequest.Builder> updateThemePermissionsRequest)	Updates the resource permissions for a theme.
default UpdateThemePermissionsResponse	updateThemePermissions(UpdateThemePermissionsRequest updateThemePermissionsRequest)	Updates the resource permissions for a theme.
default UpdateTopicResponse	updateTopic(Consumer<UpdateTopicRequest.Builder> updateTopicRequest)	Updates a topic.
default UpdateTopicResponse	updateTopic(UpdateTopicRequest updateTopicRequest)	Updates a topic.
default UpdateTopicPermissionsResponse	updateTopicPermissions(Consumer<UpdateTopicPermissionsRequest.Builder> updateTopicPermissionsRequest)	Updates the permissions of a topic.
default UpdateTopicPermissionsResponse	updateTopicPermissions(UpdateTopicPermissionsRequest updateTopicPermissionsRequest)	Updates the permissions of a topic.
default UpdateTopicRefreshScheduleResponse	updateTopicRefreshSchedule(Consumer<UpdateTopicRefreshScheduleRequest.Builder> updateTopicRefreshScheduleRequest)	Updates a topic refresh schedule.
default UpdateTopicRefreshScheduleResponse	updateTopicRefreshSchedule(UpdateTopicRefreshScheduleRequest updateTopicRefreshScheduleRequest)	Updates a topic refresh schedule.
default UpdateUserResponse	updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)	Updates an Amazon QuickSight user.
default UpdateUserResponse	updateUser(UpdateUserRequest updateUserRequest)	Updates an Amazon QuickSight user.
default UpdateVpcConnectionResponse	updateVPCConnection(Consumer<UpdateVpcConnectionRequest.Builder> updateVpcConnectionRequest)	Updates a VPC connection.
default UpdateVpcConnectionResponse	updateVPCConnection(UpdateVpcConnectionRequest updateVpcConnectionRequest)	Updates a VPC connection.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

cancelIngestion

default CancelIngestionResponse cancelIngestion(CancelIngestionRequest cancelIngestionRequest)
                                         throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
ResourceExistsException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Cancels an ongoing ingestion of data into SPICE.

Parameters:

cancelIngestionRequest -

Returns:

Result of the CancelIngestion operation returned by the service.

See Also:

• AWS API Documentation

cancelIngestion

default CancelIngestionResponse cancelIngestion(Consumer<CancelIngestionRequest.Builder> cancelIngestionRequest)
                                         throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
ResourceExistsException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Cancels an ongoing ingestion of data into SPICE.

This is a convenience which creates an instance of the CancelIngestionRequest.Builder avoiding the need to create one manually via CancelIngestionRequest.builder()

Parameters:

cancelIngestionRequest - A Consumer that will call methods on CancelIngestionRequest.Builder to create a request.

Returns:

Result of the CancelIngestion operation returned by the service.

See Also:

• AWS API Documentation

createAccountCustomization

default CreateAccountCustomizationResponse createAccountCustomization(CreateAccountCustomizationRequest createAccountCustomizationRequest)
                                                               throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User Guide.

You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.

Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.

Parameters:

createAccountCustomizationRequest -

Returns:

Result of the CreateAccountCustomization operation returned by the service.

See Also:

• AWS API Documentation

createAccountCustomization

default CreateAccountCustomizationResponse createAccountCustomization(Consumer<CreateAccountCustomizationRequest.Builder> createAccountCustomizationRequest)
                                                               throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User Guide.

You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.

Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.

This is a convenience which creates an instance of the CreateAccountCustomizationRequest.Builder avoiding the need to create one manually via CreateAccountCustomizationRequest.builder()

Parameters:

createAccountCustomizationRequest - A Consumer that will call methods on CreateAccountCustomizationRequest.Builder to create a request.

Returns:

Result of the CreateAccountCustomization operation returned by the service.

See Also:

• AWS API Documentation

createAccountSubscription

default CreateAccountSubscriptionResponse createAccountSubscription(CreateAccountSubscriptionRequest createAccountSubscriptionRequest)
                                                             throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
ResourceExistsException,
PreconditionNotMetException,
ConflictException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.

The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK. This operation isn't supported in the US East (Ohio) Region, South America (Sao Paulo) Region, or Asia Pacific (Singapore) Region.

Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon QuickSight User Guide. The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon QuickSight in the Amazon QuickSight User Guide.

If your IAM policy includes both the Subscribe and CreateAccountSubscription actions, make sure that both actions are set to Allow. If either action is set to Deny, the Deny action prevails and your API call fails.

You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the Amazon QuickSight User Guide.

You can't set default resource access on the new account from the Amazon QuickSight API. Instead, add default resource access from the Amazon QuickSight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon QuickSight User Guide.

Parameters:

createAccountSubscriptionRequest -

Returns:

Result of the CreateAccountSubscription operation returned by the service.

See Also:

• AWS API Documentation

createAccountSubscription

default CreateAccountSubscriptionResponse createAccountSubscription(Consumer<CreateAccountSubscriptionRequest.Builder> createAccountSubscriptionRequest)
                                                             throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
ResourceExistsException,
PreconditionNotMetException,
ConflictException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.

The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK. This operation isn't supported in the US East (Ohio) Region, South America (Sao Paulo) Region, or Asia Pacific (Singapore) Region.

Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon QuickSight User Guide. The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon QuickSight in the Amazon QuickSight User Guide.

If your IAM policy includes both the Subscribe and CreateAccountSubscription actions, make sure that both actions are set to Allow. If either action is set to Deny, the Deny action prevails and your API call fails.

You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the Amazon QuickSight User Guide.

You can't set default resource access on the new account from the Amazon QuickSight API. Instead, add default resource access from the Amazon QuickSight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon QuickSight User Guide.

This is a convenience which creates an instance of the CreateAccountSubscriptionRequest.Builder avoiding the need to create one manually via CreateAccountSubscriptionRequest.builder()

Parameters:

createAccountSubscriptionRequest - A Consumer that will call methods on CreateAccountSubscriptionRequest.Builder to create a request.

Returns:

Result of the CreateAccountSubscription operation returned by the service.

See Also:

• AWS API Documentation

createAnalysis

default CreateAnalysisResponse createAnalysis(CreateAnalysisRequest createAnalysisRequest)
                                       throws ResourceNotFoundException,
InvalidParameterValueException,
ThrottlingException,
ResourceExistsException,
ConflictException,
UnsupportedUserEditionException,
LimitExceededException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an AnalysisDefinition.

Parameters:

createAnalysisRequest -

Returns:

Result of the CreateAnalysis operation returned by the service.

See Also:

• AWS API Documentation

createAnalysis

default CreateAnalysisResponse createAnalysis(Consumer<CreateAnalysisRequest.Builder> createAnalysisRequest)
                                       throws ResourceNotFoundException,
InvalidParameterValueException,
ThrottlingException,
ResourceExistsException,
ConflictException,
UnsupportedUserEditionException,
LimitExceededException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an AnalysisDefinition.

This is a convenience which creates an instance of the CreateAnalysisRequest.Builder avoiding the need to create one manually via CreateAnalysisRequest.builder()

Parameters:

createAnalysisRequest - A Consumer that will call methods on CreateAnalysisRequest.Builder to create a request.

Returns:

Result of the CreateAnalysis operation returned by the service.

See Also:

• AWS API Documentation

createDashboard

default CreateDashboardResponse createDashboard(CreateDashboardRequest createDashboardRequest)
                                         throws ResourceNotFoundException,
InvalidParameterValueException,
ThrottlingException,
ResourceExistsException,
ConflictException,
UnsupportedUserEditionException,
LimitExceededException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the CreateTemplate API operation.

A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.

Parameters:

createDashboardRequest -

Returns:

Result of the CreateDashboard operation returned by the service.

See Also:

• AWS API Documentation

createDashboard

default CreateDashboardResponse createDashboard(Consumer<CreateDashboardRequest.Builder> createDashboardRequest)
                                         throws ResourceNotFoundException,
InvalidParameterValueException,
ThrottlingException,
ResourceExistsException,
ConflictException,
UnsupportedUserEditionException,
LimitExceededException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the CreateTemplate API operation.

A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.

This is a convenience which creates an instance of the CreateDashboardRequest.Builder avoiding the need to create one manually via CreateDashboardRequest.builder()

Parameters:

createDashboardRequest - A Consumer that will call methods on CreateDashboardRequest.Builder to create a request.

Returns:

Result of the CreateDashboard operation returned by the service.

See Also:

• AWS API Documentation

createDataSet

default CreateDataSetResponse createDataSet(CreateDataSetRequest createDataSetRequest)
                                     throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
LimitExceededException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.

Parameters:

createDataSetRequest -

Returns:

Result of the CreateDataSet operation returned by the service.

See Also:

• AWS API Documentation

createDataSet

default CreateDataSetResponse createDataSet(Consumer<CreateDataSetRequest.Builder> createDataSetRequest)
                                     throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
LimitExceededException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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.Builder avoiding the need to create one manually via CreateDataSetRequest.builder()

Parameters:

createDataSetRequest - A Consumer that will call methods on CreateDataSetRequest.Builder to create a request.

Returns:

Result of the CreateDataSet operation returned by the service.

See Also:

• AWS API Documentation

createDataSource

default CreateDataSourceResponse createDataSource(CreateDataSourceRequest createDataSourceRequest)
                                           throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
LimitExceededException,
ResourceNotFoundException,
ResourceExistsException,
ThrottlingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates a data source.

Parameters:

createDataSourceRequest -

Returns:

Result of the CreateDataSource operation returned by the service.

See Also:

• AWS API Documentation

createDataSource

default CreateDataSourceResponse createDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest)
                                           throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
LimitExceededException,
ResourceNotFoundException,
ResourceExistsException,
ThrottlingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates a data source.

This is a convenience which creates an instance of the CreateDataSourceRequest.Builder avoiding the need to create one manually via CreateDataSourceRequest.builder()

Parameters:

createDataSourceRequest - A Consumer that will call methods on CreateDataSourceRequest.Builder to create a request.

Returns:

Result of the CreateDataSource operation returned by the service.

See Also:

• AWS API Documentation

createFolder

default CreateFolderResponse createFolder(CreateFolderRequest createFolderRequest)
                                   throws ResourceNotFoundException,
InvalidParameterValueException,
ThrottlingException,
ResourceExistsException,
ConflictException,
UnsupportedUserEditionException,
AccessDeniedException,
LimitExceededException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates an empty shared folder.

Parameters:

createFolderRequest -

Returns:

Result of the CreateFolder operation returned by the service.

See Also:

• AWS API Documentation

createFolder

default CreateFolderResponse createFolder(Consumer<CreateFolderRequest.Builder> createFolderRequest)
                                   throws ResourceNotFoundException,
InvalidParameterValueException,
ThrottlingException,
ResourceExistsException,
ConflictException,
UnsupportedUserEditionException,
AccessDeniedException,
LimitExceededException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates an empty shared folder.

This is a convenience which creates an instance of the CreateFolderRequest.Builder avoiding the need to create one manually via CreateFolderRequest.builder()

Parameters:

createFolderRequest - A Consumer that will call methods on CreateFolderRequest.Builder to create a request.

Returns:

Result of the CreateFolder operation returned by the service.

See Also:

• AWS API Documentation

createFolderMembership

default CreateFolderMembershipResponse createFolderMembership(CreateFolderMembershipRequest createFolderMembershipRequest)
                                                       throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ResourceExistsException,
ThrottlingException,
LimitExceededException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Adds an asset, such as a dashboard, analysis, or dataset into a folder.

Parameters:

createFolderMembershipRequest -

Returns:

Result of the CreateFolderMembership operation returned by the service.

See Also:

• AWS API Documentation

createFolderMembership

default CreateFolderMembershipResponse createFolderMembership(Consumer<CreateFolderMembershipRequest.Builder> createFolderMembershipRequest)
                                                       throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ResourceExistsException,
ThrottlingException,
LimitExceededException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Adds an asset, such as a dashboard, analysis, or dataset into a folder.

This is a convenience which creates an instance of the CreateFolderMembershipRequest.Builder avoiding the need to create one manually via CreateFolderMembershipRequest.builder()

Parameters:

createFolderMembershipRequest - A Consumer that will call methods on CreateFolderMembershipRequest.Builder to create a request.

Returns:

Result of the CreateFolderMembership operation returned by the service.

See Also:

• AWS API Documentation

createGroup

default CreateGroupResponse createGroup(CreateGroupRequest createGroupRequest)
                                 throws AccessDeniedException,
InvalidParameterValueException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
LimitExceededException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Use the CreateGroup operation to create a group in Amazon QuickSight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact AWS Support.

The permissions resource is arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name> .

The response is a group object.

Parameters:

createGroupRequest - The request object for this operation.

Returns:

Result of the CreateGroup operation returned by the service.

See Also:

• AWS API Documentation

createGroup

default CreateGroupResponse createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
                                 throws AccessDeniedException,
InvalidParameterValueException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
LimitExceededException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Use the CreateGroup operation to create a group in Amazon QuickSight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact AWS Support.

The permissions resource is arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name> .

The response is a group object.

This is a convenience which creates an instance of the CreateGroupRequest.Builder avoiding the need to create one manually via CreateGroupRequest.builder()

Parameters:

createGroupRequest - A Consumer that will call methods on CreateGroupRequest.Builder to create a request. The request object for this operation.

Returns:

Result of the CreateGroup operation returned by the service.

See Also:

• AWS API Documentation

createGroupMembership

default CreateGroupMembershipResponse createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest)
                                                     throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Adds an Amazon QuickSight user to an Amazon QuickSight group.

Parameters:

createGroupMembershipRequest -

Returns:

Result of the CreateGroupMembership operation returned by the service.

See Also:

• AWS API Documentation

createGroupMembership

default CreateGroupMembershipResponse createGroupMembership(Consumer<CreateGroupMembershipRequest.Builder> createGroupMembershipRequest)
                                                     throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Adds an Amazon QuickSight user to an Amazon QuickSight group.

This is a convenience which creates an instance of the CreateGroupMembershipRequest.Builder avoiding the need to create one manually via CreateGroupMembershipRequest.builder()

Parameters:

createGroupMembershipRequest - A Consumer that will call methods on CreateGroupMembershipRequest.Builder to create a request.

Returns:

Result of the CreateGroupMembership operation returned by the service.

See Also:

• AWS API Documentation

createIAMPolicyAssignment

default CreateIamPolicyAssignmentResponse createIAMPolicyAssignment(CreateIamPolicyAssignmentRequest createIamPolicyAssignmentRequest)
                                                             throws AccessDeniedException,
InvalidParameterValueException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
ConcurrentUpdatingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.

Parameters:

createIamPolicyAssignmentRequest -

Returns:

Result of the CreateIAMPolicyAssignment operation returned by the service.

See Also:

• AWS API Documentation

createIAMPolicyAssignment

default CreateIamPolicyAssignmentResponse createIAMPolicyAssignment(Consumer<CreateIamPolicyAssignmentRequest.Builder> createIamPolicyAssignmentRequest)
                                                             throws AccessDeniedException,
InvalidParameterValueException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
ConcurrentUpdatingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.

This is a convenience which creates an instance of the CreateIamPolicyAssignmentRequest.Builder avoiding the need to create one manually via CreateIamPolicyAssignmentRequest.builder()

Parameters:

createIamPolicyAssignmentRequest - A Consumer that will call methods on CreateIamPolicyAssignmentRequest.Builder to create a request.

Returns:

Result of the CreateIAMPolicyAssignment operation returned by the service.

See Also:

• AWS API Documentation

createIngestion

default CreateIngestionResponse createIngestion(CreateIngestionRequest createIngestionRequest)
                                         throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
ResourceExistsException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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:

Result of the CreateIngestion operation returned by the service.

See Also:

• AWS API Documentation

createIngestion

default CreateIngestionResponse createIngestion(Consumer<CreateIngestionRequest.Builder> createIngestionRequest)
                                         throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
ResourceExistsException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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.Builder avoiding the need to create one manually via CreateIngestionRequest.builder()

Parameters:

createIngestionRequest - A Consumer that will call methods on CreateIngestionRequest.Builder to create a request.

Returns:

Result of the CreateIngestion operation returned by the service.

See Also:

• AWS API Documentation

createNamespace

default CreateNamespaceResponse createNamespace(CreateNamespaceRequest createNamespaceRequest)
                                         throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
ResourceExistsException,
PreconditionNotMetException,
ConflictException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.

A namespace allows you to isolate the Amazon QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.

Parameters:

createNamespaceRequest -

Returns:

Result of the CreateNamespace operation returned by the service.

See Also:

• AWS API Documentation

createNamespace

default CreateNamespaceResponse createNamespace(Consumer<CreateNamespaceRequest.Builder> createNamespaceRequest)
                                         throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
ResourceExistsException,
PreconditionNotMetException,
ConflictException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.

A namespace allows you to isolate the Amazon QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.

This is a convenience which creates an instance of the CreateNamespaceRequest.Builder avoiding the need to create one manually via CreateNamespaceRequest.builder()

Parameters:

createNamespaceRequest - A Consumer that will call methods on CreateNamespaceRequest.Builder to create a request.

Returns:

Result of the CreateNamespace operation returned by the service.

See Also:

• AWS API Documentation

createRefreshSchedule

default CreateRefreshScheduleResponse createRefreshSchedule(CreateRefreshScheduleRequest createRefreshScheduleRequest)
                                                     throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
ResourceExistsException,
PreconditionNotMetException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.

Parameters:

createRefreshScheduleRequest -

Returns:

Result of the CreateRefreshSchedule operation returned by the service.

See Also:

• AWS API Documentation

createRefreshSchedule

default CreateRefreshScheduleResponse createRefreshSchedule(Consumer<CreateRefreshScheduleRequest.Builder> createRefreshScheduleRequest)
                                                     throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
ResourceExistsException,
PreconditionNotMetException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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.Builder avoiding the need to create one manually via CreateRefreshScheduleRequest.builder()

Parameters:

createRefreshScheduleRequest - A Consumer that will call methods on CreateRefreshScheduleRequest.Builder to create a request.

Returns:

Result of the CreateRefreshSchedule operation returned by the service.

See Also:

• AWS API Documentation

createTemplate

default CreateTemplateResponse createTemplate(CreateTemplateRequest createTemplateRequest)
                                       throws InvalidParameterValueException,
AccessDeniedException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
UnsupportedUserEditionException,
ConflictException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates a template either from a TemplateDefinition or from an existing Amazon QuickSight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.

A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.

Parameters:

createTemplateRequest -

Returns:

Result of the CreateTemplate operation returned by the service.

See Also:

• AWS API Documentation

createTemplate

default CreateTemplateResponse createTemplate(Consumer<CreateTemplateRequest.Builder> createTemplateRequest)
                                       throws InvalidParameterValueException,
AccessDeniedException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
UnsupportedUserEditionException,
ConflictException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates a template either from a TemplateDefinition or from an existing Amazon QuickSight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.

A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.

This is a convenience which creates an instance of the CreateTemplateRequest.Builder avoiding the need to create one manually via CreateTemplateRequest.builder()

Parameters:

createTemplateRequest - A Consumer that will call methods on CreateTemplateRequest.Builder to create a request.

Returns:

Result of the CreateTemplate operation returned by the service.

See Also:

• AWS API Documentation

createTemplateAlias

default CreateTemplateAliasResponse createTemplateAlias(CreateTemplateAliasRequest createTemplateAliasRequest)
                                                 throws ThrottlingException,
ResourceNotFoundException,
ConflictException,
ResourceExistsException,
LimitExceededException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates a template alias for a template.

Parameters:

createTemplateAliasRequest -

Returns:

Result of the CreateTemplateAlias operation returned by the service.

See Also:

• AWS API Documentation

createTemplateAlias

default CreateTemplateAliasResponse createTemplateAlias(Consumer<CreateTemplateAliasRequest.Builder> createTemplateAliasRequest)
                                                 throws ThrottlingException,
ResourceNotFoundException,
ConflictException,
ResourceExistsException,
LimitExceededException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates a template alias for a template.

This is a convenience which creates an instance of the CreateTemplateAliasRequest.Builder avoiding the need to create one manually via CreateTemplateAliasRequest.builder()

Parameters:

createTemplateAliasRequest - A Consumer that will call methods on CreateTemplateAliasRequest.Builder to create a request.

Returns:

Result of the CreateTemplateAlias operation returned by the service.

See Also:

• AWS API Documentation

createTheme

default CreateThemeResponse createTheme(CreateThemeRequest createThemeRequest)
                                 throws AccessDeniedException,
InvalidParameterValueException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
LimitExceededException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates a theme.

A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.

Parameters:

createThemeRequest -

Returns:

Result of the CreateTheme operation returned by the service.

See Also:

• AWS API Documentation

createTheme

default CreateThemeResponse createTheme(Consumer<CreateThemeRequest.Builder> createThemeRequest)
                                 throws AccessDeniedException,
InvalidParameterValueException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
LimitExceededException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates a theme.

A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.

This is a convenience which creates an instance of the CreateThemeRequest.Builder avoiding the need to create one manually via CreateThemeRequest.builder()

Parameters:

createThemeRequest - A Consumer that will call methods on CreateThemeRequest.Builder to create a request.

Returns:

Result of the CreateTheme operation returned by the service.

See Also:

• AWS API Documentation

createThemeAlias

default CreateThemeAliasResponse createThemeAlias(CreateThemeAliasRequest createThemeAliasRequest)
                                           throws ConflictException,
InvalidParameterValueException,
LimitExceededException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates a theme alias for a theme.

Parameters:

createThemeAliasRequest -

Returns:

Result of the CreateThemeAlias operation returned by the service.

See Also:

• AWS API Documentation

createThemeAlias

default CreateThemeAliasResponse createThemeAlias(Consumer<CreateThemeAliasRequest.Builder> createThemeAliasRequest)
                                           throws ConflictException,
InvalidParameterValueException,
LimitExceededException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates a theme alias for a theme.

This is a convenience which creates an instance of the CreateThemeAliasRequest.Builder avoiding the need to create one manually via CreateThemeAliasRequest.builder()

Parameters:

createThemeAliasRequest - A Consumer that will call methods on CreateThemeAliasRequest.Builder to create a request.

Returns:

Result of the CreateThemeAlias operation returned by the service.

See Also:

• AWS API Documentation

createTopic

default CreateTopicResponse createTopic(CreateTopicRequest createTopicRequest)
                                 throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
LimitExceededException,
ResourceNotFoundException,
ResourceExistsException,
ThrottlingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates a new Q topic.

Parameters:

createTopicRequest -

Returns:

Result of the CreateTopic operation returned by the service.

See Also:

• AWS API Documentation

createTopic

default CreateTopicResponse createTopic(Consumer<CreateTopicRequest.Builder> createTopicRequest)
                                 throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
LimitExceededException,
ResourceNotFoundException,
ResourceExistsException,
ThrottlingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates a new Q topic.

This is a convenience which creates an instance of the CreateTopicRequest.Builder avoiding the need to create one manually via CreateTopicRequest.builder()

Parameters:

createTopicRequest - A Consumer that will call methods on CreateTopicRequest.Builder to create a request.

Returns:

Result of the CreateTopic operation returned by the service.

See Also:

• AWS API Documentation

createTopicRefreshSchedule

default CreateTopicRefreshScheduleResponse createTopicRefreshSchedule(CreateTopicRefreshScheduleRequest createTopicRefreshScheduleRequest)
                                                               throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
LimitExceededException,
ResourceNotFoundException,
ResourceExistsException,
ThrottlingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates a topic refresh schedule.

Parameters:

createTopicRefreshScheduleRequest -

Returns:

Result of the CreateTopicRefreshSchedule operation returned by the service.

See Also:

• AWS API Documentation

createTopicRefreshSchedule

default CreateTopicRefreshScheduleResponse createTopicRefreshSchedule(Consumer<CreateTopicRefreshScheduleRequest.Builder> createTopicRefreshScheduleRequest)
                                                               throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
LimitExceededException,
ResourceNotFoundException,
ResourceExistsException,
ThrottlingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates a topic refresh schedule.

This is a convenience which creates an instance of the CreateTopicRefreshScheduleRequest.Builder avoiding the need to create one manually via CreateTopicRefreshScheduleRequest.builder()

Parameters:

createTopicRefreshScheduleRequest - A Consumer that will call methods on CreateTopicRefreshScheduleRequest.Builder to create a request.

Returns:

Result of the CreateTopicRefreshSchedule operation returned by the service.

See Also:

• AWS API Documentation

createVPCConnection

default CreateVpcConnectionResponse createVPCConnection(CreateVpcConnectionRequest createVpcConnectionRequest)
                                                 throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
LimitExceededException,
ResourceExistsException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates a new VPC connection.

Parameters:

createVpcConnectionRequest -

Returns:

Result of the CreateVPCConnection operation returned by the service.

See Also:

• AWS API Documentation

createVPCConnection

default CreateVpcConnectionResponse createVPCConnection(Consumer<CreateVpcConnectionRequest.Builder> createVpcConnectionRequest)
                                                 throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
LimitExceededException,
ResourceExistsException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates a new VPC connection.

This is a convenience which creates an instance of the CreateVpcConnectionRequest.Builder avoiding the need to create one manually via CreateVpcConnectionRequest.builder()

Parameters:

createVpcConnectionRequest - A Consumer that will call methods on CreateVpcConnectionRequest.Builder to create a request.

Returns:

Result of the CreateVPCConnection operation returned by the service.

See Also:

• AWS API Documentation

deleteAccountCustomization

default DeleteAccountCustomizationResponse deleteAccountCustomization(DeleteAccountCustomizationRequest deleteAccountCustomizationRequest)
                                                               throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.

Parameters:

deleteAccountCustomizationRequest -

Returns:

Result of the DeleteAccountCustomization operation returned by the service.

See Also:

• AWS API Documentation

deleteAccountCustomization

default DeleteAccountCustomizationResponse deleteAccountCustomization(Consumer<DeleteAccountCustomizationRequest.Builder> deleteAccountCustomizationRequest)
                                                               throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.

This is a convenience which creates an instance of the DeleteAccountCustomizationRequest.Builder avoiding the need to create one manually via DeleteAccountCustomizationRequest.builder()

Parameters:

deleteAccountCustomizationRequest - A Consumer that will call methods on DeleteAccountCustomizationRequest.Builder to create a request.

Returns:

Result of the DeleteAccountCustomization operation returned by the service.

See Also:

• AWS API Documentation

deleteAccountSubscription

default DeleteAccountSubscriptionResponse deleteAccountSubscription(DeleteAccountSubscriptionRequest deleteAccountSubscriptionRequest)
                                                             throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Use the DeleteAccountSubscription operation to delete an Amazon QuickSight account. This operation will result in an error message if you have configured your account termination protection settings to True. To change this setting and delete your account, call the UpdateAccountSettings API and set the value of the TerminationProtectionEnabled parameter to False, then make another call to the DeleteAccountSubscription API.

Parameters:

deleteAccountSubscriptionRequest -

Returns:

Result of the DeleteAccountSubscription operation returned by the service.

See Also:

• AWS API Documentation

deleteAccountSubscription

default DeleteAccountSubscriptionResponse deleteAccountSubscription(Consumer<DeleteAccountSubscriptionRequest.Builder> deleteAccountSubscriptionRequest)
                                                             throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Use the DeleteAccountSubscription operation to delete an Amazon QuickSight account. This operation will result in an error message if you have configured your account termination protection settings to True. To change this setting and delete your account, call the UpdateAccountSettings API and set the value of the TerminationProtectionEnabled parameter to False, then make another call to the DeleteAccountSubscription API.

This is a convenience which creates an instance of the DeleteAccountSubscriptionRequest.Builder avoiding the need to create one manually via DeleteAccountSubscriptionRequest.builder()

Parameters:

deleteAccountSubscriptionRequest - A Consumer that will call methods on DeleteAccountSubscriptionRequest.Builder to create a request.

Returns:

Result of the DeleteAccountSubscription operation returned by the service.

See Also:

• AWS API Documentation

deleteAnalysis

default DeleteAnalysisResponse deleteAnalysis(DeleteAnalysisRequest deleteAnalysisRequest)
                                       throws ThrottlingException,
InvalidParameterValueException,
ConflictException,
ResourceNotFoundException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon QuickSight deletes the analysis permanently.

At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it.

An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.

Parameters:

deleteAnalysisRequest -

Returns:

Result of the DeleteAnalysis operation returned by the service.

See Also:

• AWS API Documentation

deleteAnalysis

default DeleteAnalysisResponse deleteAnalysis(Consumer<DeleteAnalysisRequest.Builder> deleteAnalysisRequest)
                                       throws ThrottlingException,
InvalidParameterValueException,
ConflictException,
ResourceNotFoundException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon QuickSight deletes the analysis permanently.

At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it.

An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.

This is a convenience which creates an instance of the DeleteAnalysisRequest.Builder avoiding the need to create one manually via DeleteAnalysisRequest.builder()

Parameters:

deleteAnalysisRequest - A Consumer that will call methods on DeleteAnalysisRequest.Builder to create a request.

Returns:

Result of the DeleteAnalysis operation returned by the service.

See Also:

• AWS API Documentation

deleteDashboard

default DeleteDashboardResponse deleteDashboard(DeleteDashboardRequest deleteDashboardRequest)
                                         throws ThrottlingException,
InvalidParameterValueException,
ConflictException,
ResourceNotFoundException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes a dashboard.

Parameters:

deleteDashboardRequest -

Returns:

Result of the DeleteDashboard operation returned by the service.

See Also:

• AWS API Documentation

deleteDashboard

default DeleteDashboardResponse deleteDashboard(Consumer<DeleteDashboardRequest.Builder> deleteDashboardRequest)
                                         throws ThrottlingException,
InvalidParameterValueException,
ConflictException,
ResourceNotFoundException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes a dashboard.

This is a convenience which creates an instance of the DeleteDashboardRequest.Builder avoiding the need to create one manually via DeleteDashboardRequest.builder()

Parameters:

deleteDashboardRequest - A Consumer that will call methods on DeleteDashboardRequest.Builder to create a request.

Returns:

Result of the DeleteDashboard operation returned by the service.

See Also:

• AWS API Documentation

deleteDataSet

default DeleteDataSetResponse deleteDataSet(DeleteDataSetRequest deleteDataSetRequest)
                                     throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes a dataset.

Parameters:

deleteDataSetRequest -

Returns:

Result of the DeleteDataSet operation returned by the service.

See Also:

• AWS API Documentation

deleteDataSet

default DeleteDataSetResponse deleteDataSet(Consumer<DeleteDataSetRequest.Builder> deleteDataSetRequest)
                                     throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes a dataset.

This is a convenience which creates an instance of the DeleteDataSetRequest.Builder avoiding the need to create one manually via DeleteDataSetRequest.builder()

Parameters:

deleteDataSetRequest - A Consumer that will call methods on DeleteDataSetRequest.Builder to create a request.

Returns:

Result of the DeleteDataSet operation returned by the service.

See Also:

• AWS API Documentation

deleteDataSetRefreshProperties

default DeleteDataSetRefreshPropertiesResponse deleteDataSetRefreshProperties(DeleteDataSetRefreshPropertiesRequest deleteDataSetRefreshPropertiesRequest)
                                                                       throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
ConflictException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes the dataset refresh properties of the dataset.

Parameters:

deleteDataSetRefreshPropertiesRequest -

Returns:

Result of the DeleteDataSetRefreshProperties operation returned by the service.

See Also:

• AWS API Documentation

deleteDataSetRefreshProperties

default DeleteDataSetRefreshPropertiesResponse deleteDataSetRefreshProperties(Consumer<DeleteDataSetRefreshPropertiesRequest.Builder> deleteDataSetRefreshPropertiesRequest)
                                                                       throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
ConflictException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes the dataset refresh properties of the dataset.

This is a convenience which creates an instance of the DeleteDataSetRefreshPropertiesRequest.Builder avoiding the need to create one manually via DeleteDataSetRefreshPropertiesRequest.builder()

Parameters:

deleteDataSetRefreshPropertiesRequest - A Consumer that will call methods on DeleteDataSetRefreshPropertiesRequest.Builder to create a request.

Returns:

Result of the DeleteDataSetRefreshProperties operation returned by the service.

See Also:

• AWS API Documentation

deleteDataSource

default DeleteDataSourceResponse deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)
                                           throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.

Parameters:

deleteDataSourceRequest -

Returns:

Result of the DeleteDataSource operation returned by the service.

See Also:

• AWS API Documentation

deleteDataSource

default DeleteDataSourceResponse deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest)
                                           throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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.Builder avoiding the need to create one manually via DeleteDataSourceRequest.builder()

Parameters:

deleteDataSourceRequest - A Consumer that will call methods on DeleteDataSourceRequest.Builder to create a request.

Returns:

Result of the DeleteDataSource operation returned by the service.

See Also:

• AWS API Documentation

deleteFolder

default DeleteFolderResponse deleteFolder(DeleteFolderRequest deleteFolderRequest)
                                   throws InvalidParameterValueException,
PreconditionNotMetException,
AccessDeniedException,
ResourceNotFoundException,
ConflictException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes an empty folder.

Parameters:

deleteFolderRequest -

Returns:

Result of the DeleteFolder operation returned by the service.

See Also:

• AWS API Documentation

deleteFolder

default DeleteFolderResponse deleteFolder(Consumer<DeleteFolderRequest.Builder> deleteFolderRequest)
                                   throws InvalidParameterValueException,
PreconditionNotMetException,
AccessDeniedException,
ResourceNotFoundException,
ConflictException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes an empty folder.

This is a convenience which creates an instance of the DeleteFolderRequest.Builder avoiding the need to create one manually via DeleteFolderRequest.builder()

Parameters:

deleteFolderRequest - A Consumer that will call methods on DeleteFolderRequest.Builder to create a request.

Returns:

Result of the DeleteFolder operation returned by the service.

See Also:

• AWS API Documentation

deleteFolderMembership

default DeleteFolderMembershipResponse deleteFolderMembership(DeleteFolderMembershipRequest deleteFolderMembershipRequest)
                                                       throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Removes an asset, such as a dashboard, analysis, or dataset, from a folder.

Parameters:

deleteFolderMembershipRequest -

Returns:

Result of the DeleteFolderMembership operation returned by the service.

See Also:

• AWS API Documentation

deleteFolderMembership

default DeleteFolderMembershipResponse deleteFolderMembership(Consumer<DeleteFolderMembershipRequest.Builder> deleteFolderMembershipRequest)
                                                       throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Removes an asset, such as a dashboard, analysis, or dataset, from a folder.

This is a convenience which creates an instance of the DeleteFolderMembershipRequest.Builder avoiding the need to create one manually via DeleteFolderMembershipRequest.builder()

Parameters:

deleteFolderMembershipRequest - A Consumer that will call methods on DeleteFolderMembershipRequest.Builder to create a request.

Returns:

Result of the DeleteFolderMembership operation returned by the service.

See Also:

• AWS API Documentation

deleteGroup

default DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest)
                                 throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Removes a user group from Amazon QuickSight.

Parameters:

deleteGroupRequest -

Returns:

Result of the DeleteGroup operation returned by the service.

See Also:

• AWS API Documentation

deleteGroup

default DeleteGroupResponse deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)
                                 throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Removes a user group from Amazon QuickSight.

This is a convenience which creates an instance of the DeleteGroupRequest.Builder avoiding the need to create one manually via DeleteGroupRequest.builder()

Parameters:

deleteGroupRequest - A Consumer that will call methods on DeleteGroupRequest.Builder to create a request.

Returns:

Result of the DeleteGroup operation returned by the service.

See Also:

• AWS API Documentation

deleteGroupMembership

default DeleteGroupMembershipResponse deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest)
                                                     throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Removes a user from a group so that the user is no longer a member of the group.

Parameters:

deleteGroupMembershipRequest -

Returns:

Result of the DeleteGroupMembership operation returned by the service.

See Also:

• AWS API Documentation

deleteGroupMembership

default DeleteGroupMembershipResponse deleteGroupMembership(Consumer<DeleteGroupMembershipRequest.Builder> deleteGroupMembershipRequest)
                                                     throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

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.Builder avoiding the need to create one manually via DeleteGroupMembershipRequest.builder()

Parameters:

deleteGroupMembershipRequest - A Consumer that will call methods on DeleteGroupMembershipRequest.Builder to create a request.

Returns:

Result of the DeleteGroupMembership operation returned by the service.

See Also:

• AWS API Documentation

deleteIAMPolicyAssignment

default DeleteIamPolicyAssignmentResponse deleteIAMPolicyAssignment(DeleteIamPolicyAssignmentRequest deleteIamPolicyAssignmentRequest)
                                                             throws AccessDeniedException,
InvalidParameterValueException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
ConcurrentUpdatingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes an existing IAM policy assignment.

Parameters:

deleteIamPolicyAssignmentRequest -

Returns:

Result of the DeleteIAMPolicyAssignment operation returned by the service.

See Also:

• AWS API Documentation

deleteIAMPolicyAssignment

default DeleteIamPolicyAssignmentResponse deleteIAMPolicyAssignment(Consumer<DeleteIamPolicyAssignmentRequest.Builder> deleteIamPolicyAssignmentRequest)
                                                             throws AccessDeniedException,
InvalidParameterValueException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
ConcurrentUpdatingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes an existing IAM policy assignment.

This is a convenience which creates an instance of the DeleteIamPolicyAssignmentRequest.Builder avoiding the need to create one manually via DeleteIamPolicyAssignmentRequest.builder()

Parameters:

deleteIamPolicyAssignmentRequest - A Consumer that will call methods on DeleteIamPolicyAssignmentRequest.Builder to create a request.

Returns:

Result of the DeleteIAMPolicyAssignment operation returned by the service.

See Also:

• AWS API Documentation

deleteNamespace

default DeleteNamespaceResponse deleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest)
                                         throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

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:

Result of the DeleteNamespace operation returned by the service.

See Also:

• AWS API Documentation

deleteNamespace

default DeleteNamespaceResponse deleteNamespace(Consumer<DeleteNamespaceRequest.Builder> deleteNamespaceRequest)
                                         throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

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.Builder avoiding the need to create one manually via DeleteNamespaceRequest.builder()

Parameters:

deleteNamespaceRequest - A Consumer that will call methods on DeleteNamespaceRequest.Builder to create a request.

Returns:

Result of the DeleteNamespace operation returned by the service.

See Also:

• AWS API Documentation

deleteRefreshSchedule

default DeleteRefreshScheduleResponse deleteRefreshSchedule(DeleteRefreshScheduleRequest deleteRefreshScheduleRequest)
                                                     throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes a refresh schedule from a dataset.

Parameters:

deleteRefreshScheduleRequest -

Returns:

Result of the DeleteRefreshSchedule operation returned by the service.

See Also:

• AWS API Documentation

deleteRefreshSchedule

default DeleteRefreshScheduleResponse deleteRefreshSchedule(Consumer<DeleteRefreshScheduleRequest.Builder> deleteRefreshScheduleRequest)
                                                     throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes a refresh schedule from a dataset.

This is a convenience which creates an instance of the DeleteRefreshScheduleRequest.Builder avoiding the need to create one manually via DeleteRefreshScheduleRequest.builder()

Parameters:

deleteRefreshScheduleRequest - A Consumer that will call methods on DeleteRefreshScheduleRequest.Builder to create a request.

Returns:

Result of the DeleteRefreshSchedule operation returned by the service.

See Also:

• AWS API Documentation

deleteTemplate

default DeleteTemplateResponse deleteTemplate(DeleteTemplateRequest deleteTemplateRequest)
                                       throws InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
LimitExceededException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes a template.

Parameters:

deleteTemplateRequest -

Returns:

Result of the DeleteTemplate operation returned by the service.

See Also:

• AWS API Documentation

deleteTemplate

default DeleteTemplateResponse deleteTemplate(Consumer<DeleteTemplateRequest.Builder> deleteTemplateRequest)
                                       throws InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
LimitExceededException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes a template.

This is a convenience which creates an instance of the DeleteTemplateRequest.Builder avoiding the need to create one manually via DeleteTemplateRequest.builder()

Parameters:

deleteTemplateRequest - A Consumer that will call methods on DeleteTemplateRequest.Builder to create a request.

Returns:

Result of the DeleteTemplate operation returned by the service.

See Also:

• AWS API Documentation

deleteTemplateAlias

default DeleteTemplateAliasResponse deleteTemplateAlias(DeleteTemplateAliasRequest deleteTemplateAliasRequest)
                                                 throws ThrottlingException,
ResourceNotFoundException,
UnsupportedUserEditionException,
ConflictException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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:

Result of the DeleteTemplateAlias operation returned by the service.

See Also:

• AWS API Documentation

deleteTemplateAlias

default DeleteTemplateAliasResponse deleteTemplateAlias(Consumer<DeleteTemplateAliasRequest.Builder> deleteTemplateAliasRequest)
                                                 throws ThrottlingException,
ResourceNotFoundException,
UnsupportedUserEditionException,
ConflictException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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.Builder avoiding the need to create one manually via DeleteTemplateAliasRequest.builder()

Parameters:

deleteTemplateAliasRequest - A Consumer that will call methods on DeleteTemplateAliasRequest.Builder to create a request.

Returns:

Result of the DeleteTemplateAlias operation returned by the service.

See Also:

• AWS API Documentation

deleteTheme

default DeleteThemeResponse deleteTheme(DeleteThemeRequest deleteThemeRequest)
                                 throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes a theme.

Parameters:

deleteThemeRequest -

Returns:

Result of the DeleteTheme operation returned by the service.

See Also:

• AWS API Documentation

deleteTheme

default DeleteThemeResponse deleteTheme(Consumer<DeleteThemeRequest.Builder> deleteThemeRequest)
                                 throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes a theme.

This is a convenience which creates an instance of the DeleteThemeRequest.Builder avoiding the need to create one manually via DeleteThemeRequest.builder()

Parameters:

deleteThemeRequest - A Consumer that will call methods on DeleteThemeRequest.Builder to create a request.

Returns:

Result of the DeleteTheme operation returned by the service.

See Also:

• AWS API Documentation

deleteThemeAlias

default DeleteThemeAliasResponse deleteThemeAlias(DeleteThemeAliasRequest deleteThemeAliasRequest)
                                           throws ConflictException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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:

Result of the DeleteThemeAlias operation returned by the service.

See Also:

• AWS API Documentation

deleteThemeAlias

default DeleteThemeAliasResponse deleteThemeAlias(Consumer<DeleteThemeAliasRequest.Builder> deleteThemeAliasRequest)
                                           throws ConflictException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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.Builder avoiding the need to create one manually via DeleteThemeAliasRequest.builder()

Parameters:

deleteThemeAliasRequest - A Consumer that will call methods on DeleteThemeAliasRequest.Builder to create a request.

Returns:

Result of the DeleteThemeAlias operation returned by the service.

See Also:

• AWS API Documentation

deleteTopic

default DeleteTopicResponse deleteTopic(DeleteTopicRequest deleteTopicRequest)
                                 throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
ConflictException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes a topic.

Parameters:

deleteTopicRequest -

Returns:

Result of the DeleteTopic operation returned by the service.

See Also:

• AWS API Documentation

deleteTopic

default DeleteTopicResponse deleteTopic(Consumer<DeleteTopicRequest.Builder> deleteTopicRequest)
                                 throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
ConflictException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes a topic.

This is a convenience which creates an instance of the DeleteTopicRequest.Builder avoiding the need to create one manually via DeleteTopicRequest.builder()

Parameters:

deleteTopicRequest - A Consumer that will call methods on DeleteTopicRequest.Builder to create a request.

Returns:

Result of the DeleteTopic operation returned by the service.

See Also:

• AWS API Documentation

deleteTopicRefreshSchedule

default DeleteTopicRefreshScheduleResponse deleteTopicRefreshSchedule(DeleteTopicRefreshScheduleRequest deleteTopicRefreshScheduleRequest)
                                                               throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
LimitExceededException,
ResourceNotFoundException,
ResourceExistsException,
ThrottlingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes a topic refresh schedule.

Parameters:

deleteTopicRefreshScheduleRequest -

Returns:

Result of the DeleteTopicRefreshSchedule operation returned by the service.

See Also:

• AWS API Documentation

deleteTopicRefreshSchedule

default DeleteTopicRefreshScheduleResponse deleteTopicRefreshSchedule(Consumer<DeleteTopicRefreshScheduleRequest.Builder> deleteTopicRefreshScheduleRequest)
                                                               throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
LimitExceededException,
ResourceNotFoundException,
ResourceExistsException,
ThrottlingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes a topic refresh schedule.

This is a convenience which creates an instance of the DeleteTopicRefreshScheduleRequest.Builder avoiding the need to create one manually via DeleteTopicRefreshScheduleRequest.builder()

Parameters:

deleteTopicRefreshScheduleRequest - A Consumer that will call methods on DeleteTopicRefreshScheduleRequest.Builder to create a request.

Returns:

Result of the DeleteTopicRefreshSchedule operation returned by the service.

See Also:

• AWS API Documentation

deleteUser

default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest)
                               throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes the Amazon QuickSight user that is associated with the identity of the IAM user or role that's making the call. The IAM user isn't deleted as a result of this call.

Parameters:

deleteUserRequest -

Returns:

Result of the DeleteUser operation returned by the service.

See Also:

• AWS API Documentation

deleteUser

default DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
                               throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes the Amazon QuickSight user that is associated with the identity of the IAM user or role that's making the call. The IAM user isn't deleted as a result of this call.

This is a convenience which creates an instance of the DeleteUserRequest.Builder avoiding the need to create one manually via DeleteUserRequest.builder()

Parameters:

deleteUserRequest - A Consumer that will call methods on DeleteUserRequest.Builder to create a request.

Returns:

Result of the DeleteUser operation returned by the service.

See Also:

• AWS API Documentation

deleteUserByPrincipalId

default DeleteUserByPrincipalIdResponse deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest deleteUserByPrincipalIdRequest)
                                                         throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes a user identified by its principal ID.

Parameters:

deleteUserByPrincipalIdRequest -

Returns:

Result of the DeleteUserByPrincipalId operation returned by the service.

See Also:

• AWS API Documentation

deleteUserByPrincipalId

default DeleteUserByPrincipalIdResponse deleteUserByPrincipalId(Consumer<DeleteUserByPrincipalIdRequest.Builder> deleteUserByPrincipalIdRequest)
                                                         throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes a user identified by its principal ID.

This is a convenience which creates an instance of the DeleteUserByPrincipalIdRequest.Builder avoiding the need to create one manually via DeleteUserByPrincipalIdRequest.builder()

Parameters:

deleteUserByPrincipalIdRequest - A Consumer that will call methods on DeleteUserByPrincipalIdRequest.Builder to create a request.

Returns:

Result of the DeleteUserByPrincipalId operation returned by the service.

See Also:

• AWS API Documentation

deleteVPCConnection

default DeleteVpcConnectionResponse deleteVPCConnection(DeleteVpcConnectionRequest deleteVpcConnectionRequest)
                                                 throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes a VPC connection.

Parameters:

deleteVpcConnectionRequest -

Returns:

Result of the DeleteVPCConnection operation returned by the service.

See Also:

• AWS API Documentation

deleteVPCConnection

default DeleteVpcConnectionResponse deleteVPCConnection(Consumer<DeleteVpcConnectionRequest.Builder> deleteVpcConnectionRequest)
                                                 throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes a VPC connection.

This is a convenience which creates an instance of the DeleteVpcConnectionRequest.Builder avoiding the need to create one manually via DeleteVpcConnectionRequest.builder()

Parameters:

deleteVpcConnectionRequest - A Consumer that will call methods on DeleteVpcConnectionRequest.Builder to create a request.

Returns:

Result of the DeleteVPCConnection operation returned by the service.

See Also:

• AWS API Documentation

describeAccountCustomization

default DescribeAccountCustomizationResponse describeAccountCustomization(DescribeAccountCustomizationRequest describeAccountCustomizationRequest)
                                                                   throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which customizations to apply by running this API operation with the Resolved flag included.

To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.

• Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region. That's where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services Region.

• Amazon Web Services Region - In each Amazon Web Services Region where you sign in to Amazon QuickSight at least once, Amazon QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to Amazon QuickSight in any Amazon Web Services Region, unless they are constrained to a namespace.

  To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options:

  • Use command line options.

  • Use named profiles.

  • Run aws configure to change your default Amazon Web Services Region. Use Enter to key the same settings for your keys. For more information, see Configuring the CLI.

• Namespace - A QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region.

• Applied customizations - Within an Amazon Web Services Region, a set of Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region. To apply them in other Amazon Web Services Regions, run the CreateAccountCustomization command in each Amazon Web Services Region where you want to apply the same customizations.

Parameters:

describeAccountCustomizationRequest -

Returns:

Result of the DescribeAccountCustomization operation returned by the service.

See Also:

• AWS API Documentation

describeAccountCustomization

default DescribeAccountCustomizationResponse describeAccountCustomization(Consumer<DescribeAccountCustomizationRequest.Builder> describeAccountCustomizationRequest)
                                                                   throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which customizations to apply by running this API operation with the Resolved flag included.

To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.

• Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region. That's where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services Region.

• Amazon Web Services Region - In each Amazon Web Services Region where you sign in to Amazon QuickSight at least once, Amazon QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to Amazon QuickSight in any Amazon Web Services Region, unless they are constrained to a namespace.

  To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options:

  • Use command line options.

  • Use named profiles.

  • Run aws configure to change your default Amazon Web Services Region. Use Enter to key the same settings for your keys. For more information, see Configuring the CLI.

• Namespace - A QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region.

• Applied customizations - Within an Amazon Web Services Region, a set of Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region. To apply them in other Amazon Web Services Regions, run the CreateAccountCustomization command in each Amazon Web Services Region where you want to apply the same customizations.

This is a convenience which creates an instance of the DescribeAccountCustomizationRequest.Builder avoiding the need to create one manually via DescribeAccountCustomizationRequest.builder()

Parameters:

describeAccountCustomizationRequest - A Consumer that will call methods on DescribeAccountCustomizationRequest.Builder to create a request.

Returns:

Result of the DescribeAccountCustomization operation returned by the service.

See Also:

• AWS API Documentation

describeAccountSettings

default DescribeAccountSettingsResponse describeAccountSettings(DescribeAccountSettingsRequest describeAccountSettingsRequest)
                                                         throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.

Parameters:

describeAccountSettingsRequest -

Returns:

Result of the DescribeAccountSettings operation returned by the service.

See Also:

• AWS API Documentation

describeAccountSettings

default DescribeAccountSettingsResponse describeAccountSettings(Consumer<DescribeAccountSettingsRequest.Builder> describeAccountSettingsRequest)
                                                         throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.

This is a convenience which creates an instance of the DescribeAccountSettingsRequest.Builder avoiding the need to create one manually via DescribeAccountSettingsRequest.builder()

Parameters:

describeAccountSettingsRequest - A Consumer that will call methods on DescribeAccountSettingsRequest.Builder to create a request.

Returns:

Result of the DescribeAccountSettings operation returned by the service.

See Also:

• AWS API Documentation

describeAccountSubscription

default DescribeAccountSubscriptionResponse describeAccountSubscription(DescribeAccountSubscriptionRequest describeAccountSubscriptionRequest)
                                                                 throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription. A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication type, edition, and notification email address.

Parameters:

describeAccountSubscriptionRequest -

Returns:

Result of the DescribeAccountSubscription operation returned by the service.

See Also:

• AWS API Documentation

describeAccountSubscription

default DescribeAccountSubscriptionResponse describeAccountSubscription(Consumer<DescribeAccountSubscriptionRequest.Builder> describeAccountSubscriptionRequest)
                                                                 throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription. A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication type, edition, and notification email address.

This is a convenience which creates an instance of the DescribeAccountSubscriptionRequest.Builder avoiding the need to create one manually via DescribeAccountSubscriptionRequest.builder()

Parameters:

describeAccountSubscriptionRequest - A Consumer that will call methods on DescribeAccountSubscriptionRequest.Builder to create a request.

Returns:

Result of the DescribeAccountSubscription operation returned by the service.

See Also:

• AWS API Documentation

describeAnalysis

default DescribeAnalysisResponse describeAnalysis(DescribeAnalysisRequest describeAnalysisRequest)
                                           throws InvalidParameterValueException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Provides a summary of the metadata for an analysis.

Parameters:

describeAnalysisRequest -

Returns:

Result of the DescribeAnalysis operation returned by the service.

See Also:

• AWS API Documentation

describeAnalysis

default DescribeAnalysisResponse describeAnalysis(Consumer<DescribeAnalysisRequest.Builder> describeAnalysisRequest)
                                           throws InvalidParameterValueException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Provides a summary of the metadata for an analysis.

This is a convenience which creates an instance of the DescribeAnalysisRequest.Builder avoiding the need to create one manually via DescribeAnalysisRequest.builder()

Parameters:

describeAnalysisRequest - A Consumer that will call methods on DescribeAnalysisRequest.Builder to create a request.

Returns:

Result of the DescribeAnalysis operation returned by the service.

See Also:

• AWS API Documentation

describeAnalysisDefinition

default DescribeAnalysisDefinitionResponse describeAnalysisDefinition(DescribeAnalysisDefinitionRequest describeAnalysisDefinitionRequest)
                                                               throws InvalidParameterValueException,
AccessDeniedException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Provides a detailed description of the definition of an analysis.

If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the DescribeAnalysis instead.

Parameters:

describeAnalysisDefinitionRequest -

Returns:

Result of the DescribeAnalysisDefinition operation returned by the service.

See Also:

• AWS API Documentation

describeAnalysisDefinition

default DescribeAnalysisDefinitionResponse describeAnalysisDefinition(Consumer<DescribeAnalysisDefinitionRequest.Builder> describeAnalysisDefinitionRequest)
                                                               throws InvalidParameterValueException,
AccessDeniedException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Provides a detailed description of the definition of an analysis.

If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the DescribeAnalysis instead.

This is a convenience which creates an instance of the DescribeAnalysisDefinitionRequest.Builder avoiding the need to create one manually via DescribeAnalysisDefinitionRequest.builder()

Parameters:

describeAnalysisDefinitionRequest - A Consumer that will call methods on DescribeAnalysisDefinitionRequest.Builder to create a request.

Returns:

Result of the DescribeAnalysisDefinition operation returned by the service.

See Also:

• AWS API Documentation

describeAnalysisPermissions

default DescribeAnalysisPermissionsResponse describeAnalysisPermissions(DescribeAnalysisPermissionsRequest describeAnalysisPermissionsRequest)
                                                                 throws InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Provides the read and write permissions for an analysis.

Parameters:

describeAnalysisPermissionsRequest -

Returns:

Result of the DescribeAnalysisPermissions operation returned by the service.

See Also:

• AWS API Documentation

describeAnalysisPermissions

default DescribeAnalysisPermissionsResponse describeAnalysisPermissions(Consumer<DescribeAnalysisPermissionsRequest.Builder> describeAnalysisPermissionsRequest)
                                                                 throws InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Provides the read and write permissions for an analysis.

This is a convenience which creates an instance of the DescribeAnalysisPermissionsRequest.Builder avoiding the need to create one manually via DescribeAnalysisPermissionsRequest.builder()

Parameters:

describeAnalysisPermissionsRequest - A Consumer that will call methods on DescribeAnalysisPermissionsRequest.Builder to create a request.

Returns:

Result of the DescribeAnalysisPermissions operation returned by the service.

See Also:

• AWS API Documentation

describeAssetBundleExportJob

default DescribeAssetBundleExportJobResponse describeAssetBundleExportJob(DescribeAssetBundleExportJobRequest describeAssetBundleExportJobRequest)
                                                                   throws UnsupportedUserEditionException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes an existing export job.

Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the DescribeAssetBundleExportJob API for a new download URL as needed.

Job descriptions are available for 14 days after the job starts.

Parameters:

describeAssetBundleExportJobRequest -

Returns:

Result of the DescribeAssetBundleExportJob operation returned by the service.

See Also:

• AWS API Documentation

describeAssetBundleExportJob

default DescribeAssetBundleExportJobResponse describeAssetBundleExportJob(Consumer<DescribeAssetBundleExportJobRequest.Builder> describeAssetBundleExportJobRequest)
                                                                   throws UnsupportedUserEditionException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes an existing export job.

Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the DescribeAssetBundleExportJob API for a new download URL as needed.

Job descriptions are available for 14 days after the job starts.

This is a convenience which creates an instance of the DescribeAssetBundleExportJobRequest.Builder avoiding the need to create one manually via DescribeAssetBundleExportJobRequest.builder()

Parameters:

describeAssetBundleExportJobRequest - A Consumer that will call methods on DescribeAssetBundleExportJobRequest.Builder to create a request.

Returns:

Result of the DescribeAssetBundleExportJob operation returned by the service.

See Also:

• AWS API Documentation

describeAssetBundleImportJob

default DescribeAssetBundleImportJobResponse describeAssetBundleImportJob(DescribeAssetBundleImportJobRequest describeAssetBundleImportJobRequest)
                                                                   throws UnsupportedUserEditionException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
QuickSightException

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:

Result of the DescribeAssetBundleImportJob operation returned by the service.

See Also:

• AWS API Documentation

describeAssetBundleImportJob

default DescribeAssetBundleImportJobResponse describeAssetBundleImportJob(Consumer<DescribeAssetBundleImportJobRequest.Builder> describeAssetBundleImportJobRequest)
                                                                   throws UnsupportedUserEditionException,
ThrottlingException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
QuickSightException

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.Builder avoiding the need to create one manually via DescribeAssetBundleImportJobRequest.builder()

Parameters:

describeAssetBundleImportJobRequest - A Consumer that will call methods on DescribeAssetBundleImportJobRequest.Builder to create a request.

Returns:

Result of the DescribeAssetBundleImportJob operation returned by the service.

See Also:

• AWS API Documentation

describeDashboard

default DescribeDashboardResponse describeDashboard(DescribeDashboardRequest describeDashboardRequest)
                                             throws InvalidParameterValueException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Provides a summary for a dashboard.

Parameters:

describeDashboardRequest -

Returns:

Result of the DescribeDashboard operation returned by the service.

See Also:

• AWS API Documentation

describeDashboard

default DescribeDashboardResponse describeDashboard(Consumer<DescribeDashboardRequest.Builder> describeDashboardRequest)
                                             throws InvalidParameterValueException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Provides a summary for a dashboard.

This is a convenience which creates an instance of the DescribeDashboardRequest.Builder avoiding the need to create one manually via DescribeDashboardRequest.builder()

Parameters:

describeDashboardRequest - A Consumer that will call methods on DescribeDashboardRequest.Builder to create a request.

Returns:

Result of the DescribeDashboard operation returned by the service.

See Also:

• AWS API Documentation

describeDashboardDefinition

default DescribeDashboardDefinitionResponse describeDashboardDefinition(DescribeDashboardDefinitionRequest describeDashboardDefinitionRequest)
                                                                 throws InvalidParameterValueException,
AccessDeniedException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Provides a detailed description of the definition of a dashboard.

If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboard instead.

Parameters:

describeDashboardDefinitionRequest -

Returns:

Result of the DescribeDashboardDefinition operation returned by the service.

See Also:

• AWS API Documentation

describeDashboardDefinition

default DescribeDashboardDefinitionResponse describeDashboardDefinition(Consumer<DescribeDashboardDefinitionRequest.Builder> describeDashboardDefinitionRequest)
                                                                 throws InvalidParameterValueException,
AccessDeniedException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Provides a detailed description of the definition of a dashboard.

If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboard instead.

This is a convenience which creates an instance of the DescribeDashboardDefinitionRequest.Builder avoiding the need to create one manually via DescribeDashboardDefinitionRequest.builder()

Parameters:

describeDashboardDefinitionRequest - A Consumer that will call methods on DescribeDashboardDefinitionRequest.Builder to create a request.

Returns:

Result of the DescribeDashboardDefinition operation returned by the service.

See Also:

• AWS API Documentation

describeDashboardPermissions

default DescribeDashboardPermissionsResponse describeDashboardPermissions(DescribeDashboardPermissionsRequest describeDashboardPermissionsRequest)
                                                                   throws InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes read and write permissions for a dashboard.

Parameters:

describeDashboardPermissionsRequest -

Returns:

Result of the DescribeDashboardPermissions operation returned by the service.

See Also:

• AWS API Documentation

describeDashboardPermissions

default DescribeDashboardPermissionsResponse describeDashboardPermissions(Consumer<DescribeDashboardPermissionsRequest.Builder> describeDashboardPermissionsRequest)
                                                                   throws InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes read and write permissions for a dashboard.

This is a convenience which creates an instance of the DescribeDashboardPermissionsRequest.Builder avoiding the need to create one manually via DescribeDashboardPermissionsRequest.builder()

Parameters:

describeDashboardPermissionsRequest - A Consumer that will call methods on DescribeDashboardPermissionsRequest.Builder to create a request.

Returns:

Result of the DescribeDashboardPermissions operation returned by the service.

See Also:

• AWS API Documentation

describeDashboardSnapshotJob

default DescribeDashboardSnapshotJobResponse describeDashboardSnapshotJob(DescribeDashboardSnapshotJobRequest describeDashboardSnapshotJobRequest)
                                                                   throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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:

Result of the DescribeDashboardSnapshotJob operation returned by the service.

See Also:

• AWS API Documentation

describeDashboardSnapshotJob

default DescribeDashboardSnapshotJobResponse describeDashboardSnapshotJob(Consumer<DescribeDashboardSnapshotJobRequest.Builder> describeDashboardSnapshotJobRequest)
                                                                   throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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.Builder avoiding the need to create one manually via DescribeDashboardSnapshotJobRequest.builder()

Parameters:

describeDashboardSnapshotJobRequest - A Consumer that will call methods on DescribeDashboardSnapshotJobRequest.Builder to create a request.

Returns:

Result of the DescribeDashboardSnapshotJob operation returned by the service.

See Also:

• AWS API Documentation

describeDashboardSnapshotJobResult

default DescribeDashboardSnapshotJobResultResponse describeDashboardSnapshotJobResult(DescribeDashboardSnapshotJobResultRequest describeDashboardSnapshotJobResultRequest)
                                                                               throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
PreconditionNotMetException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes the result of an existing snapshot job that has finished running.

A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API 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:

Result of the DescribeDashboardSnapshotJobResult operation returned by the service.

See Also:

• AWS API Documentation

describeDashboardSnapshotJobResult

default DescribeDashboardSnapshotJobResultResponse describeDashboardSnapshotJobResult(Consumer<DescribeDashboardSnapshotJobResultRequest.Builder> describeDashboardSnapshotJobResultRequest)
                                                                               throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
PreconditionNotMetException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes the result of an existing snapshot job that has finished running.

A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API 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.Builder avoiding the need to create one manually via DescribeDashboardSnapshotJobResultRequest.builder()

Parameters:

describeDashboardSnapshotJobResultRequest - A Consumer that will call methods on DescribeDashboardSnapshotJobResultRequest.Builder to create a request.

Returns:

Result of the DescribeDashboardSnapshotJobResult operation returned by the service.

See Also:

• AWS API Documentation

describeDataSet

default DescribeDataSetResponse describeDataSet(DescribeDataSetRequest describeDataSetRequest)
                                         throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.

Parameters:

describeDataSetRequest -

Returns:

Result of the DescribeDataSet operation returned by the service.

See Also:

• AWS API Documentation

describeDataSet

default DescribeDataSetResponse describeDataSet(Consumer<DescribeDataSetRequest.Builder> describeDataSetRequest)
                                         throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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.Builder avoiding the need to create one manually via DescribeDataSetRequest.builder()

Parameters:

describeDataSetRequest - A Consumer that will call methods on DescribeDataSetRequest.Builder to create a request.

Returns:

Result of the DescribeDataSet operation returned by the service.

See Also:

• AWS API Documentation

describeDataSetPermissions

default DescribeDataSetPermissionsResponse describeDataSetPermissions(DescribeDataSetPermissionsRequest describeDataSetPermissionsRequest)
                                                               throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes the permissions on a dataset.

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

Parameters:

describeDataSetPermissionsRequest -

Returns:

Result of the DescribeDataSetPermissions operation returned by the service.

See Also:

• AWS API Documentation

describeDataSetPermissions

default DescribeDataSetPermissionsResponse describeDataSetPermissions(Consumer<DescribeDataSetPermissionsRequest.Builder> describeDataSetPermissionsRequest)
                                                               throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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.Builder avoiding the need to create one manually via DescribeDataSetPermissionsRequest.builder()

Parameters:

describeDataSetPermissionsRequest - A Consumer that will call methods on DescribeDataSetPermissionsRequest.Builder to create a request.

Returns:

Result of the DescribeDataSetPermissions operation returned by the service.

See Also:

• AWS API Documentation

describeDataSetRefreshProperties

default DescribeDataSetRefreshPropertiesResponse describeDataSetRefreshProperties(DescribeDataSetRefreshPropertiesRequest describeDataSetRefreshPropertiesRequest)
                                                                           throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
PreconditionNotMetException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes the refresh properties of a dataset.

Parameters:

describeDataSetRefreshPropertiesRequest -

Returns:

Result of the DescribeDataSetRefreshProperties operation returned by the service.

See Also:

• AWS API Documentation

describeDataSetRefreshProperties

default DescribeDataSetRefreshPropertiesResponse describeDataSetRefreshProperties(Consumer<DescribeDataSetRefreshPropertiesRequest.Builder> describeDataSetRefreshPropertiesRequest)
                                                                           throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
PreconditionNotMetException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes the refresh properties of a dataset.

This is a convenience which creates an instance of the DescribeDataSetRefreshPropertiesRequest.Builder avoiding the need to create one manually via DescribeDataSetRefreshPropertiesRequest.builder()

Parameters:

describeDataSetRefreshPropertiesRequest - A Consumer that will call methods on DescribeDataSetRefreshPropertiesRequest.Builder to create a request.

Returns:

Result of the DescribeDataSetRefreshProperties operation returned by the service.

See Also:

• AWS API Documentation

describeDataSource

default DescribeDataSourceResponse describeDataSource(DescribeDataSourceRequest describeDataSourceRequest)
                                               throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes a data source.

Parameters:

describeDataSourceRequest -

Returns:

Result of the DescribeDataSource operation returned by the service.

See Also:

• AWS API Documentation

describeDataSource

default DescribeDataSourceResponse describeDataSource(Consumer<DescribeDataSourceRequest.Builder> describeDataSourceRequest)
                                               throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes a data source.

This is a convenience which creates an instance of the DescribeDataSourceRequest.Builder avoiding the need to create one manually via DescribeDataSourceRequest.builder()

Parameters:

describeDataSourceRequest - A Consumer that will call methods on DescribeDataSourceRequest.Builder to create a request.

Returns:

Result of the DescribeDataSource operation returned by the service.

See Also:

• AWS API Documentation

describeDataSourcePermissions

default DescribeDataSourcePermissionsResponse describeDataSourcePermissions(DescribeDataSourcePermissionsRequest describeDataSourcePermissionsRequest)
                                                                     throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes the resource permissions for a data source.

Parameters:

describeDataSourcePermissionsRequest -

Returns:

Result of the DescribeDataSourcePermissions operation returned by the service.

See Also:

• AWS API Documentation

describeDataSourcePermissions

default DescribeDataSourcePermissionsResponse describeDataSourcePermissions(Consumer<DescribeDataSourcePermissionsRequest.Builder> describeDataSourcePermissionsRequest)
                                                                     throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes the resource permissions for a data source.

This is a convenience which creates an instance of the DescribeDataSourcePermissionsRequest.Builder avoiding the need to create one manually via DescribeDataSourcePermissionsRequest.builder()

Parameters:

describeDataSourcePermissionsRequest - A Consumer that will call methods on DescribeDataSourcePermissionsRequest.Builder to create a request.

Returns:

Result of the DescribeDataSourcePermissions operation returned by the service.

See Also:

• AWS API Documentation

describeFolder

default DescribeFolderResponse describeFolder(DescribeFolderRequest describeFolderRequest)
                                       throws InvalidParameterValueException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes a folder.

Parameters:

describeFolderRequest -

Returns:

Result of the DescribeFolder operation returned by the service.

See Also:

• AWS API Documentation

describeFolder

default DescribeFolderResponse describeFolder(Consumer<DescribeFolderRequest.Builder> describeFolderRequest)
                                       throws InvalidParameterValueException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes a folder.

This is a convenience which creates an instance of the DescribeFolderRequest.Builder avoiding the need to create one manually via DescribeFolderRequest.builder()

Parameters:

describeFolderRequest - A Consumer that will call methods on DescribeFolderRequest.Builder to create a request.

Returns:

Result of the DescribeFolder operation returned by the service.

See Also:

• AWS API Documentation

describeFolderPermissions

default DescribeFolderPermissionsResponse describeFolderPermissions(DescribeFolderPermissionsRequest describeFolderPermissionsRequest)
                                                             throws InvalidParameterValueException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes permissions for a folder.

Parameters:

describeFolderPermissionsRequest -

Returns:

Result of the DescribeFolderPermissions operation returned by the service.

See Also:

• AWS API Documentation

describeFolderPermissions

default DescribeFolderPermissionsResponse describeFolderPermissions(Consumer<DescribeFolderPermissionsRequest.Builder> describeFolderPermissionsRequest)
                                                             throws InvalidParameterValueException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes permissions for a folder.

This is a convenience which creates an instance of the DescribeFolderPermissionsRequest.Builder avoiding the need to create one manually via DescribeFolderPermissionsRequest.builder()

Parameters:

describeFolderPermissionsRequest - A Consumer that will call methods on DescribeFolderPermissionsRequest.Builder to create a request.

Returns:

Result of the DescribeFolderPermissions operation returned by the service.

See Also:

• AWS API Documentation

describeFolderPermissionsPaginator

default DescribeFolderPermissionsIterable describeFolderPermissionsPaginator(DescribeFolderPermissionsRequest describeFolderPermissionsRequest)
                                                                      throws InvalidParameterValueException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes permissions for a folder.

This is a variant of describeFolderPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.DescribeFolderPermissionsIterable responses = client.describeFolderPermissionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.DescribeFolderPermissionsIterable responses = client
             .describeFolderPermissionsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.DescribeFolderPermissionsIterable responses = client.describeFolderPermissionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeFolderPermissionsPaginator

default DescribeFolderPermissionsIterable describeFolderPermissionsPaginator(Consumer<DescribeFolderPermissionsRequest.Builder> describeFolderPermissionsRequest)
                                                                      throws InvalidParameterValueException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes permissions for a folder.

This is a variant of describeFolderPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.DescribeFolderPermissionsIterable responses = client.describeFolderPermissionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.DescribeFolderPermissionsIterable responses = client
             .describeFolderPermissionsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.DescribeFolderPermissionsIterable responses = client.describeFolderPermissionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via DescribeFolderPermissionsRequest.builder()

Parameters:

describeFolderPermissionsRequest - A Consumer that will call methods on DescribeFolderPermissionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeFolderResolvedPermissions

default DescribeFolderResolvedPermissionsResponse describeFolderResolvedPermissions(DescribeFolderResolvedPermissionsRequest describeFolderResolvedPermissionsRequest)
                                                                             throws InvalidParameterValueException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.

Parameters:

describeFolderResolvedPermissionsRequest -

Returns:

Result of the DescribeFolderResolvedPermissions operation returned by the service.

See Also:

• AWS API Documentation

describeFolderResolvedPermissions

default DescribeFolderResolvedPermissionsResponse describeFolderResolvedPermissions(Consumer<DescribeFolderResolvedPermissionsRequest.Builder> describeFolderResolvedPermissionsRequest)
                                                                             throws InvalidParameterValueException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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.Builder avoiding the need to create one manually via DescribeFolderResolvedPermissionsRequest.builder()

Parameters:

describeFolderResolvedPermissionsRequest - A Consumer that will call methods on DescribeFolderResolvedPermissionsRequest.Builder to create a request.

Returns:

Result of the DescribeFolderResolvedPermissions operation returned by the service.

See Also:

• AWS API Documentation

describeFolderResolvedPermissionsPaginator

default DescribeFolderResolvedPermissionsIterable describeFolderResolvedPermissionsPaginator(DescribeFolderResolvedPermissionsRequest describeFolderResolvedPermissionsRequest)
                                                                                      throws InvalidParameterValueException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.

This is a variant of describeFolderResolvedPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.DescribeFolderResolvedPermissionsIterable responses = client.describeFolderResolvedPermissionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.DescribeFolderResolvedPermissionsIterable responses = client
             .describeFolderResolvedPermissionsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.DescribeFolderResolvedPermissionsIterable responses = client.describeFolderResolvedPermissionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeFolderResolvedPermissionsPaginator

default DescribeFolderResolvedPermissionsIterable describeFolderResolvedPermissionsPaginator(Consumer<DescribeFolderResolvedPermissionsRequest.Builder> describeFolderResolvedPermissionsRequest)
                                                                                      throws InvalidParameterValueException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.

This is a variant of describeFolderResolvedPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.DescribeFolderResolvedPermissionsIterable responses = client.describeFolderResolvedPermissionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.DescribeFolderResolvedPermissionsIterable responses = client
             .describeFolderResolvedPermissionsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.DescribeFolderResolvedPermissionsIterable responses = client.describeFolderResolvedPermissionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via DescribeFolderResolvedPermissionsRequest.builder()

Parameters:

describeFolderResolvedPermissionsRequest - A Consumer that will call methods on DescribeFolderResolvedPermissionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeGroup

default DescribeGroupResponse describeGroup(DescribeGroupRequest describeGroupRequest)
                                     throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).

Parameters:

describeGroupRequest -

Returns:

Result of the DescribeGroup operation returned by the service.

See Also:

• AWS API Documentation

describeGroup

default DescribeGroupResponse describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest)
                                     throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).

This is a convenience which creates an instance of the DescribeGroupRequest.Builder avoiding the need to create one manually via DescribeGroupRequest.builder()

Parameters:

describeGroupRequest - A Consumer that will call methods on DescribeGroupRequest.Builder to create a request.

Returns:

Result of the DescribeGroup operation returned by the service.

See Also:

• AWS API Documentation

describeGroupMembership

default DescribeGroupMembershipResponse describeGroupMembership(DescribeGroupMembershipRequest describeGroupMembershipRequest)
                                                         throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Use the DescribeGroupMembership operation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associated GroupMember object is returned.

Parameters:

describeGroupMembershipRequest -

Returns:

Result of the DescribeGroupMembership operation returned by the service.

See Also:

• AWS API Documentation

describeGroupMembership

default DescribeGroupMembershipResponse describeGroupMembership(Consumer<DescribeGroupMembershipRequest.Builder> describeGroupMembershipRequest)
                                                         throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Use the DescribeGroupMembership operation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associated GroupMember object is returned.

This is a convenience which creates an instance of the DescribeGroupMembershipRequest.Builder avoiding the need to create one manually via DescribeGroupMembershipRequest.builder()

Parameters:

describeGroupMembershipRequest - A Consumer that will call methods on DescribeGroupMembershipRequest.Builder to create a request.

Returns:

Result of the DescribeGroupMembership operation returned by the service.

See Also:

• AWS API Documentation

describeIAMPolicyAssignment

default DescribeIamPolicyAssignmentResponse describeIAMPolicyAssignment(DescribeIamPolicyAssignmentRequest describeIamPolicyAssignmentRequest)
                                                                 throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes an existing IAM policy assignment, as specified by the assignment name.

Parameters:

describeIamPolicyAssignmentRequest -

Returns:

Result of the DescribeIAMPolicyAssignment operation returned by the service.

See Also:

• AWS API Documentation

describeIAMPolicyAssignment

default DescribeIamPolicyAssignmentResponse describeIAMPolicyAssignment(Consumer<DescribeIamPolicyAssignmentRequest.Builder> describeIamPolicyAssignmentRequest)
                                                                 throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes an existing IAM policy assignment, as specified by the assignment name.

This is a convenience which creates an instance of the DescribeIamPolicyAssignmentRequest.Builder avoiding the need to create one manually via DescribeIamPolicyAssignmentRequest.builder()

Parameters:

describeIamPolicyAssignmentRequest - A Consumer that will call methods on DescribeIamPolicyAssignmentRequest.Builder to create a request.

Returns:

Result of the DescribeIAMPolicyAssignment operation returned by the service.

See Also:

• AWS API Documentation

describeIngestion

default DescribeIngestionResponse describeIngestion(DescribeIngestionRequest describeIngestionRequest)
                                             throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
ResourceExistsException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes a SPICE ingestion.

Parameters:

describeIngestionRequest -

Returns:

Result of the DescribeIngestion operation returned by the service.

See Also:

• AWS API Documentation

describeIngestion

default DescribeIngestionResponse describeIngestion(Consumer<DescribeIngestionRequest.Builder> describeIngestionRequest)
                                             throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
ResourceExistsException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes a SPICE ingestion.

This is a convenience which creates an instance of the DescribeIngestionRequest.Builder avoiding the need to create one manually via DescribeIngestionRequest.builder()

Parameters:

describeIngestionRequest - A Consumer that will call methods on DescribeIngestionRequest.Builder to create a request.

Returns:

Result of the DescribeIngestion operation returned by the service.

See Also:

• AWS API Documentation

describeIpRestriction

default DescribeIpRestrictionResponse describeIpRestriction(DescribeIpRestrictionRequest describeIpRestrictionRequest)
                                                     throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Provides a summary and status of IP rules.

Parameters:

describeIpRestrictionRequest -

Returns:

Result of the DescribeIpRestriction operation returned by the service.

See Also:

• AWS API Documentation

describeIpRestriction

default DescribeIpRestrictionResponse describeIpRestriction(Consumer<DescribeIpRestrictionRequest.Builder> describeIpRestrictionRequest)
                                                     throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Provides a summary and status of IP rules.

This is a convenience which creates an instance of the DescribeIpRestrictionRequest.Builder avoiding the need to create one manually via DescribeIpRestrictionRequest.builder()

Parameters:

describeIpRestrictionRequest - A Consumer that will call methods on DescribeIpRestrictionRequest.Builder to create a request.

Returns:

Result of the DescribeIpRestriction operation returned by the service.

See Also:

• AWS API Documentation

describeNamespace

default DescribeNamespaceResponse describeNamespace(DescribeNamespaceRequest describeNamespaceRequest)
                                             throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes the current namespace.

Parameters:

describeNamespaceRequest -

Returns:

Result of the DescribeNamespace operation returned by the service.

See Also:

• AWS API Documentation

describeNamespace

default DescribeNamespaceResponse describeNamespace(Consumer<DescribeNamespaceRequest.Builder> describeNamespaceRequest)
                                             throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes the current namespace.

This is a convenience which creates an instance of the DescribeNamespaceRequest.Builder avoiding the need to create one manually via DescribeNamespaceRequest.builder()

Parameters:

describeNamespaceRequest - A Consumer that will call methods on DescribeNamespaceRequest.Builder to create a request.

Returns:

Result of the DescribeNamespace operation returned by the service.

See Also:

• AWS API Documentation

describeRefreshSchedule

default DescribeRefreshScheduleResponse describeRefreshSchedule(DescribeRefreshScheduleRequest describeRefreshScheduleRequest)
                                                         throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Provides a summary of a refresh schedule.

Parameters:

describeRefreshScheduleRequest -

Returns:

Result of the DescribeRefreshSchedule operation returned by the service.

See Also:

• AWS API Documentation

describeRefreshSchedule

default DescribeRefreshScheduleResponse describeRefreshSchedule(Consumer<DescribeRefreshScheduleRequest.Builder> describeRefreshScheduleRequest)
                                                         throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Provides a summary of a refresh schedule.

This is a convenience which creates an instance of the DescribeRefreshScheduleRequest.Builder avoiding the need to create one manually via DescribeRefreshScheduleRequest.builder()

Parameters:

describeRefreshScheduleRequest - A Consumer that will call methods on DescribeRefreshScheduleRequest.Builder to create a request.

Returns:

Result of the DescribeRefreshSchedule operation returned by the service.

See Also:

• AWS API Documentation

describeTemplate

default DescribeTemplateResponse describeTemplate(DescribeTemplateRequest describeTemplateRequest)
                                           throws InvalidParameterValueException,
AccessDeniedException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes a template's metadata.

Parameters:

describeTemplateRequest -

Returns:

Result of the DescribeTemplate operation returned by the service.

See Also:

• AWS API Documentation

describeTemplate

default DescribeTemplateResponse describeTemplate(Consumer<DescribeTemplateRequest.Builder> describeTemplateRequest)
                                           throws InvalidParameterValueException,
AccessDeniedException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes a template's metadata.

This is a convenience which creates an instance of the DescribeTemplateRequest.Builder avoiding the need to create one manually via DescribeTemplateRequest.builder()

Parameters:

describeTemplateRequest - A Consumer that will call methods on DescribeTemplateRequest.Builder to create a request.

Returns:

Result of the DescribeTemplate operation returned by the service.

See Also:

• AWS API Documentation

describeTemplateAlias

default DescribeTemplateAliasResponse describeTemplateAlias(DescribeTemplateAliasRequest describeTemplateAliasRequest)
                                                     throws ThrottlingException,
ResourceNotFoundException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes the template alias for a template.

Parameters:

describeTemplateAliasRequest -

Returns:

Result of the DescribeTemplateAlias operation returned by the service.

See Also:

• AWS API Documentation

describeTemplateAlias

default DescribeTemplateAliasResponse describeTemplateAlias(Consumer<DescribeTemplateAliasRequest.Builder> describeTemplateAliasRequest)
                                                     throws ThrottlingException,
ResourceNotFoundException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes the template alias for a template.

This is a convenience which creates an instance of the DescribeTemplateAliasRequest.Builder avoiding the need to create one manually via DescribeTemplateAliasRequest.builder()

Parameters:

describeTemplateAliasRequest - A Consumer that will call methods on DescribeTemplateAliasRequest.Builder to create a request.

Returns:

Result of the DescribeTemplateAlias operation returned by the service.

See Also:

• AWS API Documentation

describeTemplateDefinition

default DescribeTemplateDefinitionResponse describeTemplateDefinition(DescribeTemplateDefinitionRequest describeTemplateDefinitionRequest)
                                                               throws InvalidParameterValueException,
AccessDeniedException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Provides a detailed description of the definition of a template.

If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the DescribeTemplate instead.

Parameters:

describeTemplateDefinitionRequest -

Returns:

Result of the DescribeTemplateDefinition operation returned by the service.

See Also:

• AWS API Documentation

describeTemplateDefinition

default DescribeTemplateDefinitionResponse describeTemplateDefinition(Consumer<DescribeTemplateDefinitionRequest.Builder> describeTemplateDefinitionRequest)
                                                               throws InvalidParameterValueException,
AccessDeniedException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Provides a detailed description of the definition of a template.

If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the DescribeTemplate instead.

This is a convenience which creates an instance of the DescribeTemplateDefinitionRequest.Builder avoiding the need to create one manually via DescribeTemplateDefinitionRequest.builder()

Parameters:

describeTemplateDefinitionRequest - A Consumer that will call methods on DescribeTemplateDefinitionRequest.Builder to create a request.

Returns:

Result of the DescribeTemplateDefinition operation returned by the service.

See Also:

• AWS API Documentation

describeTemplatePermissions

default DescribeTemplatePermissionsResponse describeTemplatePermissions(DescribeTemplatePermissionsRequest describeTemplatePermissionsRequest)
                                                                 throws ThrottlingException,
InvalidParameterValueException,
ConflictException,
ResourceNotFoundException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes read and write permissions on a template.

Parameters:

describeTemplatePermissionsRequest -

Returns:

Result of the DescribeTemplatePermissions operation returned by the service.

See Also:

• AWS API Documentation

describeTemplatePermissions

default DescribeTemplatePermissionsResponse describeTemplatePermissions(Consumer<DescribeTemplatePermissionsRequest.Builder> describeTemplatePermissionsRequest)
                                                                 throws ThrottlingException,
InvalidParameterValueException,
ConflictException,
ResourceNotFoundException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes read and write permissions on a template.

This is a convenience which creates an instance of the DescribeTemplatePermissionsRequest.Builder avoiding the need to create one manually via DescribeTemplatePermissionsRequest.builder()

Parameters:

describeTemplatePermissionsRequest - A Consumer that will call methods on DescribeTemplatePermissionsRequest.Builder to create a request.

Returns:

Result of the DescribeTemplatePermissions operation returned by the service.

See Also:

• AWS API Documentation

describeTheme

default DescribeThemeResponse describeTheme(DescribeThemeRequest describeThemeRequest)
                                     throws AccessDeniedException,
InvalidParameterValueException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes a theme.

Parameters:

describeThemeRequest -

Returns:

Result of the DescribeTheme operation returned by the service.

See Also:

• AWS API Documentation

describeTheme

default DescribeThemeResponse describeTheme(Consumer<DescribeThemeRequest.Builder> describeThemeRequest)
                                     throws AccessDeniedException,
InvalidParameterValueException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes a theme.

This is a convenience which creates an instance of the DescribeThemeRequest.Builder avoiding the need to create one manually via DescribeThemeRequest.builder()

Parameters:

describeThemeRequest - A Consumer that will call methods on DescribeThemeRequest.Builder to create a request.

Returns:

Result of the DescribeTheme operation returned by the service.

See Also:

• AWS API Documentation

describeThemeAlias

default DescribeThemeAliasResponse describeThemeAlias(DescribeThemeAliasRequest describeThemeAliasRequest)
                                               throws ConflictException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes the alias for a theme.

Parameters:

describeThemeAliasRequest -

Returns:

Result of the DescribeThemeAlias operation returned by the service.

See Also:

• AWS API Documentation

describeThemeAlias

default DescribeThemeAliasResponse describeThemeAlias(Consumer<DescribeThemeAliasRequest.Builder> describeThemeAliasRequest)
                                               throws ConflictException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes the alias for a theme.

This is a convenience which creates an instance of the DescribeThemeAliasRequest.Builder avoiding the need to create one manually via DescribeThemeAliasRequest.builder()

Parameters:

describeThemeAliasRequest - A Consumer that will call methods on DescribeThemeAliasRequest.Builder to create a request.

Returns:

Result of the DescribeThemeAlias operation returned by the service.

See Also:

• AWS API Documentation

describeThemePermissions

default DescribeThemePermissionsResponse describeThemePermissions(DescribeThemePermissionsRequest describeThemePermissionsRequest)
                                                           throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes the read and write permissions for a theme.

Parameters:

describeThemePermissionsRequest -

Returns:

Result of the DescribeThemePermissions operation returned by the service.

See Also:

• AWS API Documentation

describeThemePermissions

default DescribeThemePermissionsResponse describeThemePermissions(Consumer<DescribeThemePermissionsRequest.Builder> describeThemePermissionsRequest)
                                                           throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes the read and write permissions for a theme.

This is a convenience which creates an instance of the DescribeThemePermissionsRequest.Builder avoiding the need to create one manually via DescribeThemePermissionsRequest.builder()

Parameters:

describeThemePermissionsRequest - A Consumer that will call methods on DescribeThemePermissionsRequest.Builder to create a request.

Returns:

Result of the DescribeThemePermissions operation returned by the service.

See Also:

• AWS API Documentation

describeTopic

default DescribeTopicResponse describeTopic(DescribeTopicRequest describeTopicRequest)
                                     throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes a topic.

Parameters:

describeTopicRequest -

Returns:

Result of the DescribeTopic operation returned by the service.

See Also:

• AWS API Documentation

describeTopic

default DescribeTopicResponse describeTopic(Consumer<DescribeTopicRequest.Builder> describeTopicRequest)
                                     throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes a topic.

This is a convenience which creates an instance of the DescribeTopicRequest.Builder avoiding the need to create one manually via DescribeTopicRequest.builder()

Parameters:

describeTopicRequest - A Consumer that will call methods on DescribeTopicRequest.Builder to create a request.

Returns:

Result of the DescribeTopic operation returned by the service.

See Also:

• AWS API Documentation

describeTopicPermissions

default DescribeTopicPermissionsResponse describeTopicPermissions(DescribeTopicPermissionsRequest describeTopicPermissionsRequest)
                                                           throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes the permissions of a topic.

Parameters:

describeTopicPermissionsRequest -

Returns:

Result of the DescribeTopicPermissions operation returned by the service.

See Also:

• AWS API Documentation

describeTopicPermissions

default DescribeTopicPermissionsResponse describeTopicPermissions(Consumer<DescribeTopicPermissionsRequest.Builder> describeTopicPermissionsRequest)
                                                           throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes the permissions of a topic.

This is a convenience which creates an instance of the DescribeTopicPermissionsRequest.Builder avoiding the need to create one manually via DescribeTopicPermissionsRequest.builder()

Parameters:

describeTopicPermissionsRequest - A Consumer that will call methods on DescribeTopicPermissionsRequest.Builder to create a request.

Returns:

Result of the DescribeTopicPermissions operation returned by the service.

See Also:

• AWS API Documentation

describeTopicRefresh

default DescribeTopicRefreshResponse describeTopicRefresh(DescribeTopicRefreshRequest describeTopicRefreshRequest)
                                                   throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes the status of a topic refresh.

Parameters:

describeTopicRefreshRequest -

Returns:

Result of the DescribeTopicRefresh operation returned by the service.

See Also:

• AWS API Documentation

describeTopicRefresh

default DescribeTopicRefreshResponse describeTopicRefresh(Consumer<DescribeTopicRefreshRequest.Builder> describeTopicRefreshRequest)
                                                   throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes the status of a topic refresh.

This is a convenience which creates an instance of the DescribeTopicRefreshRequest.Builder avoiding the need to create one manually via DescribeTopicRefreshRequest.builder()

Parameters:

describeTopicRefreshRequest - A Consumer that will call methods on DescribeTopicRefreshRequest.Builder to create a request.

Returns:

Result of the DescribeTopicRefresh operation returned by the service.

See Also:

• AWS API Documentation

describeTopicRefreshSchedule

default DescribeTopicRefreshScheduleResponse describeTopicRefreshSchedule(DescribeTopicRefreshScheduleRequest describeTopicRefreshScheduleRequest)
                                                                   throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
LimitExceededException,
ResourceNotFoundException,
ResourceExistsException,
ThrottlingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes a topic refresh schedule.

Parameters:

describeTopicRefreshScheduleRequest -

Returns:

Result of the DescribeTopicRefreshSchedule operation returned by the service.

See Also:

• AWS API Documentation

describeTopicRefreshSchedule

default DescribeTopicRefreshScheduleResponse describeTopicRefreshSchedule(Consumer<DescribeTopicRefreshScheduleRequest.Builder> describeTopicRefreshScheduleRequest)
                                                                   throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
LimitExceededException,
ResourceNotFoundException,
ResourceExistsException,
ThrottlingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Deletes a topic refresh schedule.

This is a convenience which creates an instance of the DescribeTopicRefreshScheduleRequest.Builder avoiding the need to create one manually via DescribeTopicRefreshScheduleRequest.builder()

Parameters:

describeTopicRefreshScheduleRequest - A Consumer that will call methods on DescribeTopicRefreshScheduleRequest.Builder to create a request.

Returns:

Result of the DescribeTopicRefreshSchedule operation returned by the service.

See Also:

• AWS API Documentation

describeUser

default DescribeUserResponse describeUser(DescribeUserRequest describeUserRequest)
                                   throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Returns information about a user, given the user name.

Parameters:

describeUserRequest -

Returns:

Result of the DescribeUser operation returned by the service.

See Also:

• AWS API Documentation

describeUser

default DescribeUserResponse describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)
                                   throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Returns information about a user, given the user name.

This is a convenience which creates an instance of the DescribeUserRequest.Builder avoiding the need to create one manually via DescribeUserRequest.builder()

Parameters:

describeUserRequest - A Consumer that will call methods on DescribeUserRequest.Builder to create a request.

Returns:

Result of the DescribeUser operation returned by the service.

See Also:

• AWS API Documentation

describeVPCConnection

default DescribeVpcConnectionResponse describeVPCConnection(DescribeVpcConnectionRequest describeVpcConnectionRequest)
                                                     throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes a VPC connection.

Parameters:

describeVpcConnectionRequest -

Returns:

Result of the DescribeVPCConnection operation returned by the service.

See Also:

• AWS API Documentation

describeVPCConnection

default DescribeVpcConnectionResponse describeVPCConnection(Consumer<DescribeVpcConnectionRequest.Builder> describeVpcConnectionRequest)
                                                     throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Describes a VPC connection.

This is a convenience which creates an instance of the DescribeVpcConnectionRequest.Builder avoiding the need to create one manually via DescribeVpcConnectionRequest.builder()

Parameters:

describeVpcConnectionRequest - A Consumer that will call methods on DescribeVpcConnectionRequest.Builder to create a request.

Returns:

Result of the DescribeVPCConnection operation returned by the service.

See Also:

• AWS API Documentation

generateEmbedUrlForAnonymousUser

default GenerateEmbedUrlForAnonymousUserResponse generateEmbedUrlForAnonymousUser(GenerateEmbedUrlForAnonymousUserRequest generateEmbedUrlForAnonymousUserRequest)
                                                                           throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
SessionLifetimeInMinutesInvalidException,
UnsupportedUserEditionException,
UnsupportedPricingPlanException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.

The following rules apply to the generated URL:

• It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.

• The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.

• You are charged only when the URL is used or there is interaction with Amazon QuickSight.

For more information, see Embedded Analytics in the Amazon QuickSight User Guide.

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

Parameters:

generateEmbedUrlForAnonymousUserRequest -

Returns:

Result of the GenerateEmbedUrlForAnonymousUser operation returned by the service.

See Also:

• AWS API Documentation

generateEmbedUrlForAnonymousUser

default GenerateEmbedUrlForAnonymousUserResponse generateEmbedUrlForAnonymousUser(Consumer<GenerateEmbedUrlForAnonymousUserRequest.Builder> generateEmbedUrlForAnonymousUserRequest)
                                                                           throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
SessionLifetimeInMinutesInvalidException,
UnsupportedUserEditionException,
UnsupportedPricingPlanException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.

The following rules apply to the generated URL:

• It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.

• The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.

• You are charged only when the URL is used or there is interaction with Amazon QuickSight.

For more information, see Embedded Analytics in the Amazon QuickSight User Guide.

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

This is a convenience which creates an instance of the GenerateEmbedUrlForAnonymousUserRequest.Builder avoiding the need to create one manually via GenerateEmbedUrlForAnonymousUserRequest.builder()

Parameters:

generateEmbedUrlForAnonymousUserRequest - A Consumer that will call methods on GenerateEmbedUrlForAnonymousUserRequest.Builder to create a request.

Returns:

Result of the GenerateEmbedUrlForAnonymousUser operation returned by the service.

See Also:

• AWS API Documentation

generateEmbedUrlForRegisteredUser

default GenerateEmbedUrlForRegisteredUserResponse generateEmbedUrlForRegisteredUser(GenerateEmbedUrlForRegisteredUserRequest generateEmbedUrlForRegisteredUserRequest)
                                                                             throws AccessDeniedException,
InvalidParameterValueException,
QuickSightUserNotFoundException,
ResourceNotFoundException,
SessionLifetimeInMinutesInvalidException,
ThrottlingException,
UnsupportedUserEditionException,
UnsupportedPricingPlanException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.

The following rules apply to the generated URL:

• It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.

• The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter.

  The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.

• You are charged only when the URL is used or there is interaction with Amazon QuickSight.

For more information, see Embedded Analytics in the Amazon QuickSight User Guide.

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

Parameters:

generateEmbedUrlForRegisteredUserRequest -

Returns:

Result of the GenerateEmbedUrlForRegisteredUser operation returned by the service.

See Also:

• AWS API Documentation

generateEmbedUrlForRegisteredUser

default GenerateEmbedUrlForRegisteredUserResponse generateEmbedUrlForRegisteredUser(Consumer<GenerateEmbedUrlForRegisteredUserRequest.Builder> generateEmbedUrlForRegisteredUserRequest)
                                                                             throws AccessDeniedException,
InvalidParameterValueException,
QuickSightUserNotFoundException,
ResourceNotFoundException,
SessionLifetimeInMinutesInvalidException,
ThrottlingException,
UnsupportedUserEditionException,
UnsupportedPricingPlanException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.

The following rules apply to the generated URL:

• It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.

• The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter.

  The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.

• You are charged only when the URL is used or there is interaction with Amazon QuickSight.

For more information, see Embedded Analytics in the Amazon QuickSight User Guide.

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

This is a convenience which creates an instance of the GenerateEmbedUrlForRegisteredUserRequest.Builder avoiding the need to create one manually via GenerateEmbedUrlForRegisteredUserRequest.builder()

Parameters:

generateEmbedUrlForRegisteredUserRequest - A Consumer that will call methods on GenerateEmbedUrlForRegisteredUserRequest.Builder to create a request.

Returns:

Result of the GenerateEmbedUrlForRegisteredUser operation returned by the service.

See Also:

• AWS API Documentation

getDashboardEmbedUrl

default GetDashboardEmbedUrlResponse getDashboardEmbedUrl(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest)
                                                   throws AccessDeniedException,
InvalidParameterValueException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
DomainNotWhitelistedException,
QuickSightUserNotFoundException,
IdentityTypeNotSupportedException,
SessionLifetimeInMinutesInvalidException,
UnsupportedUserEditionException,
UnsupportedPricingPlanException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions.

Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the generated URL:

• They must be used together.

• They can be used one time only.

• They are valid for 5 minutes after you run this command.

• You are charged only when the URL is used or there is interaction with Amazon QuickSight.

• The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional SessionLifetimeInMinutes parameter to customize session duration.

For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide.

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

Parameters:

getDashboardEmbedUrlRequest -

Returns:

Result of the GetDashboardEmbedUrl operation returned by the service.

See Also:

• AWS API Documentation

getDashboardEmbedUrl

default GetDashboardEmbedUrlResponse getDashboardEmbedUrl(Consumer<GetDashboardEmbedUrlRequest.Builder> getDashboardEmbedUrlRequest)
                                                   throws AccessDeniedException,
InvalidParameterValueException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
DomainNotWhitelistedException,
QuickSightUserNotFoundException,
IdentityTypeNotSupportedException,
SessionLifetimeInMinutesInvalidException,
UnsupportedUserEditionException,
UnsupportedPricingPlanException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions.

Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the generated URL:

• They must be used together.

• They can be used one time only.

• They are valid for 5 minutes after you run this command.

• You are charged only when the URL is used or there is interaction with Amazon QuickSight.

• The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional SessionLifetimeInMinutes parameter to customize session duration.

For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide.

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

This is a convenience which creates an instance of the GetDashboardEmbedUrlRequest.Builder avoiding the need to create one manually via GetDashboardEmbedUrlRequest.builder()

Parameters:

getDashboardEmbedUrlRequest - A Consumer that will call methods on GetDashboardEmbedUrlRequest.Builder to create a request.

Returns:

Result of the GetDashboardEmbedUrl operation returned by the service.

See Also:

• AWS API Documentation

getSessionEmbedUrl

default GetSessionEmbedUrlResponse getSessionEmbedUrl(GetSessionEmbedUrlRequest getSessionEmbedUrlRequest)
                                               throws AccessDeniedException,
InvalidParameterValueException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
QuickSightUserNotFoundException,
SessionLifetimeInMinutesInvalidException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:

• Embedding Analytics

• Customizing Access to the Amazon QuickSight Console

Parameters:

getSessionEmbedUrlRequest -

Returns:

Result of the GetSessionEmbedUrl operation returned by the service.

See Also:

• AWS API Documentation

getSessionEmbedUrl

default GetSessionEmbedUrlResponse getSessionEmbedUrl(Consumer<GetSessionEmbedUrlRequest.Builder> getSessionEmbedUrlRequest)
                                               throws AccessDeniedException,
InvalidParameterValueException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
QuickSightUserNotFoundException,
SessionLifetimeInMinutesInvalidException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:

• Embedding Analytics

• Customizing Access to the Amazon QuickSight Console

This is a convenience which creates an instance of the GetSessionEmbedUrlRequest.Builder avoiding the need to create one manually via GetSessionEmbedUrlRequest.builder()

Parameters:

getSessionEmbedUrlRequest - A Consumer that will call methods on GetSessionEmbedUrlRequest.Builder to create a request.

Returns:

Result of the GetSessionEmbedUrl operation returned by the service.

See Also:

• AWS API Documentation

listAnalyses

default ListAnalysesResponse listAnalyses(ListAnalysesRequest listAnalysesRequest)
                                   throws ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.

Parameters:

listAnalysesRequest -

Returns:

Result of the ListAnalyses operation returned by the service.

See Also:

• AWS API Documentation

listAnalyses

default ListAnalysesResponse listAnalyses(Consumer<ListAnalysesRequest.Builder> listAnalysesRequest)
                                   throws ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.

This is a convenience which creates an instance of the ListAnalysesRequest.Builder avoiding the need to create one manually via ListAnalysesRequest.builder()

Parameters:

listAnalysesRequest - A Consumer that will call methods on ListAnalysesRequest.Builder to create a request.

Returns:

Result of the ListAnalyses operation returned by the service.

See Also:

• AWS API Documentation

listAnalysesPaginator

default ListAnalysesIterable listAnalysesPaginator(ListAnalysesRequest listAnalysesRequest)
                                            throws ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.

This is a variant of listAnalyses(software.amazon.awssdk.services.quicksight.model.ListAnalysesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListAnalysesIterable responses = client.listAnalysesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListAnalysesIterable responses = client.listAnalysesPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListAnalysesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListAnalysesIterable responses = client.listAnalysesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAnalysesPaginator

default ListAnalysesIterable listAnalysesPaginator(Consumer<ListAnalysesRequest.Builder> listAnalysesRequest)
                                            throws ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.

This is a variant of listAnalyses(software.amazon.awssdk.services.quicksight.model.ListAnalysesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListAnalysesIterable responses = client.listAnalysesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListAnalysesIterable responses = client.listAnalysesPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListAnalysesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListAnalysesIterable responses = client.listAnalysesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListAnalysesRequest.builder()

Parameters:

listAnalysesRequest - A Consumer that will call methods on ListAnalysesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAssetBundleExportJobs

default ListAssetBundleExportJobsResponse listAssetBundleExportJobs(ListAssetBundleExportJobsRequest listAssetBundleExportJobsRequest)
                                                             throws UnsupportedUserEditionException,
ThrottlingException,
AccessDeniedException,
InvalidNextTokenException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleExportJobs only returns the most recent job that uses the repeated job ID.

Parameters:

listAssetBundleExportJobsRequest -

Returns:

Result of the ListAssetBundleExportJobs operation returned by the service.

See Also:

• AWS API Documentation

listAssetBundleExportJobs

default ListAssetBundleExportJobsResponse listAssetBundleExportJobs(Consumer<ListAssetBundleExportJobsRequest.Builder> listAssetBundleExportJobsRequest)
                                                             throws UnsupportedUserEditionException,
ThrottlingException,
AccessDeniedException,
InvalidNextTokenException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleExportJobs only returns the most recent job that uses the repeated job ID.

This is a convenience which creates an instance of the ListAssetBundleExportJobsRequest.Builder avoiding the need to create one manually via ListAssetBundleExportJobsRequest.builder()

Parameters:

listAssetBundleExportJobsRequest - A Consumer that will call methods on ListAssetBundleExportJobsRequest.Builder to create a request.

Returns:

Result of the ListAssetBundleExportJobs operation returned by the service.

See Also:

• AWS API Documentation

listAssetBundleExportJobsPaginator

default ListAssetBundleExportJobsIterable listAssetBundleExportJobsPaginator(ListAssetBundleExportJobsRequest listAssetBundleExportJobsRequest)
                                                                      throws UnsupportedUserEditionException,
ThrottlingException,
AccessDeniedException,
InvalidNextTokenException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleExportJobs only returns the most recent job that uses the repeated job ID.

This is a variant of listAssetBundleExportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListAssetBundleExportJobsIterable responses = client.listAssetBundleExportJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListAssetBundleExportJobsIterable responses = client
             .listAssetBundleExportJobsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListAssetBundleExportJobsIterable responses = client.listAssetBundleExportJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAssetBundleExportJobsPaginator

default ListAssetBundleExportJobsIterable listAssetBundleExportJobsPaginator(Consumer<ListAssetBundleExportJobsRequest.Builder> listAssetBundleExportJobsRequest)
                                                                      throws UnsupportedUserEditionException,
ThrottlingException,
AccessDeniedException,
InvalidNextTokenException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleExportJobs only returns the most recent job that uses the repeated job ID.

This is a variant of listAssetBundleExportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListAssetBundleExportJobsIterable responses = client.listAssetBundleExportJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListAssetBundleExportJobsIterable responses = client
             .listAssetBundleExportJobsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListAssetBundleExportJobsIterable responses = client.listAssetBundleExportJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListAssetBundleExportJobsRequest.builder()

Parameters:

listAssetBundleExportJobsRequest - A Consumer that will call methods on ListAssetBundleExportJobsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAssetBundleImportJobs

default ListAssetBundleImportJobsResponse listAssetBundleImportJobs(ListAssetBundleImportJobsRequest listAssetBundleImportJobsRequest)
                                                             throws UnsupportedUserEditionException,
ThrottlingException,
AccessDeniedException,
InvalidNextTokenException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleImportJobs only returns the most recent job that uses the repeated job ID.

Parameters:

listAssetBundleImportJobsRequest -

Returns:

Result of the ListAssetBundleImportJobs operation returned by the service.

See Also:

• AWS API Documentation

listAssetBundleImportJobs

default ListAssetBundleImportJobsResponse listAssetBundleImportJobs(Consumer<ListAssetBundleImportJobsRequest.Builder> listAssetBundleImportJobsRequest)
                                                             throws UnsupportedUserEditionException,
ThrottlingException,
AccessDeniedException,
InvalidNextTokenException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleImportJobs only returns the most recent job that uses the repeated job ID.

This is a convenience which creates an instance of the ListAssetBundleImportJobsRequest.Builder avoiding the need to create one manually via ListAssetBundleImportJobsRequest.builder()

Parameters:

listAssetBundleImportJobsRequest - A Consumer that will call methods on ListAssetBundleImportJobsRequest.Builder to create a request.

Returns:

Result of the ListAssetBundleImportJobs operation returned by the service.

See Also:

• AWS API Documentation

listAssetBundleImportJobsPaginator

default ListAssetBundleImportJobsIterable listAssetBundleImportJobsPaginator(ListAssetBundleImportJobsRequest listAssetBundleImportJobsRequest)
                                                                      throws UnsupportedUserEditionException,
ThrottlingException,
AccessDeniedException,
InvalidNextTokenException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleImportJobs only returns the most recent job that uses the repeated job ID.

This is a variant of listAssetBundleImportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListAssetBundleImportJobsIterable responses = client.listAssetBundleImportJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListAssetBundleImportJobsIterable responses = client
             .listAssetBundleImportJobsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListAssetBundleImportJobsIterable responses = client.listAssetBundleImportJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAssetBundleImportJobsPaginator

default ListAssetBundleImportJobsIterable listAssetBundleImportJobsPaginator(Consumer<ListAssetBundleImportJobsRequest.Builder> listAssetBundleImportJobsRequest)
                                                                      throws UnsupportedUserEditionException,
ThrottlingException,
AccessDeniedException,
InvalidNextTokenException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleImportJobs only returns the most recent job that uses the repeated job ID.

This is a variant of listAssetBundleImportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListAssetBundleImportJobsIterable responses = client.listAssetBundleImportJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListAssetBundleImportJobsIterable responses = client
             .listAssetBundleImportJobsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListAssetBundleImportJobsIterable responses = client.listAssetBundleImportJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListAssetBundleImportJobsRequest.builder()

Parameters:

listAssetBundleImportJobsRequest - A Consumer that will call methods on ListAssetBundleImportJobsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDashboardVersions

default ListDashboardVersionsResponse listDashboardVersions(ListDashboardVersionsRequest listDashboardVersionsRequest)
                                                     throws InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all the versions of the dashboards in the Amazon QuickSight subscription.

Parameters:

listDashboardVersionsRequest -

Returns:

Result of the ListDashboardVersions operation returned by the service.

See Also:

• AWS API Documentation

listDashboardVersions

default ListDashboardVersionsResponse listDashboardVersions(Consumer<ListDashboardVersionsRequest.Builder> listDashboardVersionsRequest)
                                                     throws InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all the versions of the dashboards in the Amazon QuickSight subscription.

This is a convenience which creates an instance of the ListDashboardVersionsRequest.Builder avoiding the need to create one manually via ListDashboardVersionsRequest.builder()

Parameters:

listDashboardVersionsRequest - A Consumer that will call methods on ListDashboardVersionsRequest.Builder to create a request.

Returns:

Result of the ListDashboardVersions operation returned by the service.

See Also:

• AWS API Documentation

listDashboardVersionsPaginator

default ListDashboardVersionsIterable listDashboardVersionsPaginator(ListDashboardVersionsRequest listDashboardVersionsRequest)
                                                              throws InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all the versions of the dashboards in the Amazon QuickSight subscription.

This is a variant of listDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsIterable responses = client.listDashboardVersionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsIterable responses = client
             .listDashboardVersionsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsIterable responses = client.listDashboardVersionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDashboardVersionsPaginator

default ListDashboardVersionsIterable listDashboardVersionsPaginator(Consumer<ListDashboardVersionsRequest.Builder> listDashboardVersionsRequest)
                                                              throws InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all the versions of the dashboards in the Amazon QuickSight subscription.

This is a variant of listDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsIterable responses = client.listDashboardVersionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsIterable responses = client
             .listDashboardVersionsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsIterable responses = client.listDashboardVersionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListDashboardVersionsRequest.builder()

Parameters:

listDashboardVersionsRequest - A Consumer that will call methods on ListDashboardVersionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDashboards

default ListDashboardsResponse listDashboards(ListDashboardsRequest listDashboardsRequest)
                                       throws ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists dashboards in an Amazon Web Services account.

Parameters:

listDashboardsRequest -

Returns:

Result of the ListDashboards operation returned by the service.

See Also:

• AWS API Documentation

listDashboards

default ListDashboardsResponse listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)
                                       throws ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists dashboards in an Amazon Web Services account.

This is a convenience which creates an instance of the ListDashboardsRequest.Builder avoiding the need to create one manually via ListDashboardsRequest.builder()

Parameters:

listDashboardsRequest - A Consumer that will call methods on ListDashboardsRequest.Builder to create a request.

Returns:

Result of the ListDashboards operation returned by the service.

See Also:

• AWS API Documentation

listDashboardsPaginator

default ListDashboardsIterable listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest)
                                                throws ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists dashboards in an Amazon Web Services account.

This is a variant of listDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListDashboardsIterable responses = client
             .listDashboardsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListDashboardsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDashboardsPaginator

default ListDashboardsIterable listDashboardsPaginator(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)
                                                throws ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists dashboards in an Amazon Web Services account.

This is a variant of listDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListDashboardsIterable responses = client
             .listDashboardsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListDashboardsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListDashboardsRequest.builder()

Parameters:

listDashboardsRequest - A Consumer that will call methods on ListDashboardsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDataSets

default ListDataSetsResponse listDataSets(ListDataSetsRequest listDataSetsRequest)
                                   throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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:

Result of the ListDataSets operation returned by the service.

See Also:

• AWS API Documentation

listDataSets

default ListDataSetsResponse listDataSets(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest)
                                   throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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.Builder avoiding the need to create one manually via ListDataSetsRequest.builder()

Parameters:

listDataSetsRequest - A Consumer that will call methods on ListDataSetsRequest.Builder to create a request.

Returns:

Result of the ListDataSets operation returned by the service.

See Also:

• AWS API Documentation

listDataSetsPaginator

default ListDataSetsIterable listDataSetsPaginator(ListDataSetsRequest listDataSetsRequest)
                                            throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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 variant of listDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListDataSetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDataSetsPaginator

default ListDataSetsIterable listDataSetsPaginator(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest)
                                            throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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 variant of listDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListDataSetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListDataSetsRequest.builder()

Parameters:

listDataSetsRequest - A Consumer that will call methods on ListDataSetsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDataSources

default ListDataSourcesResponse listDataSources(ListDataSourcesRequest listDataSourcesRequest)
                                         throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.

Parameters:

listDataSourcesRequest -

Returns:

Result of the ListDataSources operation returned by the service.

See Also:

• AWS API Documentation

listDataSources

default ListDataSourcesResponse listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)
                                         throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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.Builder avoiding the need to create one manually via ListDataSourcesRequest.builder()

Parameters:

listDataSourcesRequest - A Consumer that will call methods on ListDataSourcesRequest.Builder to create a request.

Returns:

Result of the ListDataSources operation returned by the service.

See Also:

• AWS API Documentation

listDataSourcesPaginator

default ListDataSourcesIterable listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest)
                                                  throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.

This is a variant of listDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesIterable responses = client
             .listDataSourcesPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListDataSourcesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDataSourcesPaginator

default ListDataSourcesIterable listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)
                                                  throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.

This is a variant of listDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesIterable responses = client
             .listDataSourcesPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListDataSourcesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListDataSourcesRequest.builder()

Parameters:

listDataSourcesRequest - A Consumer that will call methods on ListDataSourcesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listFolderMembers

default ListFolderMembersResponse listFolderMembers(ListFolderMembersRequest listFolderMembersRequest)
                                             throws InvalidParameterValueException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.

Parameters:

listFolderMembersRequest -

Returns:

Result of the ListFolderMembers operation returned by the service.

See Also:

• AWS API Documentation

listFolderMembers

default ListFolderMembersResponse listFolderMembers(Consumer<ListFolderMembersRequest.Builder> listFolderMembersRequest)
                                             throws InvalidParameterValueException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.

This is a convenience which creates an instance of the ListFolderMembersRequest.Builder avoiding the need to create one manually via ListFolderMembersRequest.builder()

Parameters:

listFolderMembersRequest - A Consumer that will call methods on ListFolderMembersRequest.Builder to create a request.

Returns:

Result of the ListFolderMembers operation returned by the service.

See Also:

• AWS API Documentation

listFolderMembersPaginator

default ListFolderMembersIterable listFolderMembersPaginator(ListFolderMembersRequest listFolderMembersRequest)
                                                      throws InvalidParameterValueException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.

This is a variant of listFolderMembers(software.amazon.awssdk.services.quicksight.model.ListFolderMembersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListFolderMembersIterable responses = client.listFolderMembersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListFolderMembersIterable responses = client
             .listFolderMembersPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListFolderMembersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListFolderMembersIterable responses = client.listFolderMembersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listFolderMembersPaginator

default ListFolderMembersIterable listFolderMembersPaginator(Consumer<ListFolderMembersRequest.Builder> listFolderMembersRequest)
                                                      throws InvalidParameterValueException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.

This is a variant of listFolderMembers(software.amazon.awssdk.services.quicksight.model.ListFolderMembersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListFolderMembersIterable responses = client.listFolderMembersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListFolderMembersIterable responses = client
             .listFolderMembersPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListFolderMembersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListFolderMembersIterable responses = client.listFolderMembersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListFolderMembersRequest.builder()

Parameters:

listFolderMembersRequest - A Consumer that will call methods on ListFolderMembersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listFolders

default ListFoldersResponse listFolders(ListFoldersRequest listFoldersRequest)
                                 throws InvalidParameterValueException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all folders in an account.

Parameters:

listFoldersRequest -

Returns:

Result of the ListFolders operation returned by the service.

See Also:

• AWS API Documentation

listFolders

default ListFoldersResponse listFolders(Consumer<ListFoldersRequest.Builder> listFoldersRequest)
                                 throws InvalidParameterValueException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all folders in an account.

This is a convenience which creates an instance of the ListFoldersRequest.Builder avoiding the need to create one manually via ListFoldersRequest.builder()

Parameters:

listFoldersRequest - A Consumer that will call methods on ListFoldersRequest.Builder to create a request.

Returns:

Result of the ListFolders operation returned by the service.

See Also:

• AWS API Documentation

listFoldersPaginator

default ListFoldersIterable listFoldersPaginator(ListFoldersRequest listFoldersRequest)
                                          throws InvalidParameterValueException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all folders in an account.

This is a variant of listFolders(software.amazon.awssdk.services.quicksight.model.ListFoldersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListFoldersIterable responses = client.listFoldersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListFoldersIterable responses = client.listFoldersPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListFoldersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListFoldersIterable responses = client.listFoldersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listFoldersPaginator

default ListFoldersIterable listFoldersPaginator(Consumer<ListFoldersRequest.Builder> listFoldersRequest)
                                          throws InvalidParameterValueException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all folders in an account.

This is a variant of listFolders(software.amazon.awssdk.services.quicksight.model.ListFoldersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListFoldersIterable responses = client.listFoldersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListFoldersIterable responses = client.listFoldersPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListFoldersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListFoldersIterable responses = client.listFoldersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListFoldersRequest.builder()

Parameters:

listFoldersRequest - A Consumer that will call methods on ListFoldersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listGroupMemberships

default ListGroupMembershipsResponse listGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest)
                                                   throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists member users in a group.

Parameters:

listGroupMembershipsRequest -

Returns:

Result of the ListGroupMemberships operation returned by the service.

See Also:

• AWS API Documentation

listGroupMemberships

default ListGroupMembershipsResponse listGroupMemberships(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest)
                                                   throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists member users in a group.

This is a convenience which creates an instance of the ListGroupMembershipsRequest.Builder avoiding the need to create one manually via ListGroupMembershipsRequest.builder()

Parameters:

listGroupMembershipsRequest - A Consumer that will call methods on ListGroupMembershipsRequest.Builder to create a request.

Returns:

Result of the ListGroupMemberships operation returned by the service.

See Also:

• AWS API Documentation

listGroupMembershipsPaginator

default ListGroupMembershipsIterable listGroupMembershipsPaginator(ListGroupMembershipsRequest listGroupMembershipsRequest)
                                                            throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists member users in a group.

This is a variant of listGroupMemberships(software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListGroupMembershipsIterable responses = client.listGroupMembershipsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListGroupMembershipsIterable responses = client
             .listGroupMembershipsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListGroupMembershipsIterable responses = client.listGroupMembershipsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listGroupMembershipsPaginator

default ListGroupMembershipsIterable listGroupMembershipsPaginator(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest)
                                                            throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists member users in a group.

This is a variant of listGroupMemberships(software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListGroupMembershipsIterable responses = client.listGroupMembershipsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListGroupMembershipsIterable responses = client
             .listGroupMembershipsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListGroupMembershipsIterable responses = client.listGroupMembershipsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListGroupMembershipsRequest.builder()

Parameters:

listGroupMembershipsRequest - A Consumer that will call methods on ListGroupMembershipsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listGroups

default ListGroupsResponse listGroups(ListGroupsRequest listGroupsRequest)
                               throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all user groups in Amazon QuickSight.

Parameters:

listGroupsRequest -

Returns:

Result of the ListGroups operation returned by the service.

See Also:

• AWS API Documentation

listGroups

default ListGroupsResponse listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
                               throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all user groups in Amazon QuickSight.

This is a convenience which creates an instance of the ListGroupsRequest.Builder avoiding the need to create one manually via ListGroupsRequest.builder()

Parameters:

listGroupsRequest - A Consumer that will call methods on ListGroupsRequest.Builder to create a request.

Returns:

Result of the ListGroups operation returned by the service.

See Also:

• AWS API Documentation

listGroupsPaginator

default ListGroupsIterable listGroupsPaginator(ListGroupsRequest listGroupsRequest)
                                        throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all user groups in Amazon QuickSight.

This is a variant of listGroups(software.amazon.awssdk.services.quicksight.model.ListGroupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listGroupsPaginator

default ListGroupsIterable listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
                                        throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all user groups in Amazon QuickSight.

This is a variant of listGroups(software.amazon.awssdk.services.quicksight.model.ListGroupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListGroupsRequest.builder()

Parameters:

listGroupsRequest - A Consumer that will call methods on ListGroupsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listIAMPolicyAssignments

default ListIamPolicyAssignmentsResponse listIAMPolicyAssignments(ListIamPolicyAssignmentsRequest listIamPolicyAssignmentsRequest)
                                                           throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists the IAM policy assignments in the current Amazon QuickSight account.

Parameters:

listIamPolicyAssignmentsRequest -

Returns:

Result of the ListIAMPolicyAssignments operation returned by the service.

See Also:

• AWS API Documentation

listIAMPolicyAssignments

default ListIamPolicyAssignmentsResponse listIAMPolicyAssignments(Consumer<ListIamPolicyAssignmentsRequest.Builder> listIamPolicyAssignmentsRequest)
                                                           throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists the IAM policy assignments in the current Amazon QuickSight account.

This is a convenience which creates an instance of the ListIamPolicyAssignmentsRequest.Builder avoiding the need to create one manually via ListIamPolicyAssignmentsRequest.builder()

Parameters:

listIamPolicyAssignmentsRequest - A Consumer that will call methods on ListIamPolicyAssignmentsRequest.Builder to create a request.

Returns:

Result of the ListIAMPolicyAssignments operation returned by the service.

See Also:

• AWS API Documentation

listIAMPolicyAssignmentsPaginator

default ListIAMPolicyAssignmentsIterable listIAMPolicyAssignmentsPaginator(ListIamPolicyAssignmentsRequest listIamPolicyAssignmentsRequest)
                                                                    throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists the IAM policy assignments in the current Amazon QuickSight account.

This is a variant of listIAMPolicyAssignments(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsIterable responses = client.listIAMPolicyAssignmentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsIterable responses = client
             .listIAMPolicyAssignmentsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsIterable responses = client.listIAMPolicyAssignmentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listIAMPolicyAssignmentsPaginator

default ListIAMPolicyAssignmentsIterable listIAMPolicyAssignmentsPaginator(Consumer<ListIamPolicyAssignmentsRequest.Builder> listIamPolicyAssignmentsRequest)
                                                                    throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists the IAM policy assignments in the current Amazon QuickSight account.

This is a variant of listIAMPolicyAssignments(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsIterable responses = client.listIAMPolicyAssignmentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsIterable responses = client
             .listIAMPolicyAssignmentsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsIterable responses = client.listIAMPolicyAssignmentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListIamPolicyAssignmentsRequest.builder()

Parameters:

listIamPolicyAssignmentsRequest - A Consumer that will call methods on ListIamPolicyAssignmentsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listIAMPolicyAssignmentsForUser

default ListIamPolicyAssignmentsForUserResponse listIAMPolicyAssignmentsForUser(ListIamPolicyAssignmentsForUserRequest listIamPolicyAssignmentsForUserRequest)
                                                                         throws AccessDeniedException,
InvalidParameterValueException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
ConcurrentUpdatingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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:

Result of the ListIAMPolicyAssignmentsForUser operation returned by the service.

See Also:

• AWS API Documentation

listIAMPolicyAssignmentsForUser

default ListIamPolicyAssignmentsForUserResponse listIAMPolicyAssignmentsForUser(Consumer<ListIamPolicyAssignmentsForUserRequest.Builder> listIamPolicyAssignmentsForUserRequest)
                                                                         throws AccessDeniedException,
InvalidParameterValueException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
ConcurrentUpdatingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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.Builder avoiding the need to create one manually via ListIamPolicyAssignmentsForUserRequest.builder()

Parameters:

listIamPolicyAssignmentsForUserRequest - A Consumer that will call methods on ListIamPolicyAssignmentsForUserRequest.Builder to create a request.

Returns:

Result of the ListIAMPolicyAssignmentsForUser operation returned by the service.

See Also:

• AWS API Documentation

listIAMPolicyAssignmentsForUserPaginator

default ListIAMPolicyAssignmentsForUserIterable listIAMPolicyAssignmentsForUserPaginator(ListIamPolicyAssignmentsForUserRequest listIamPolicyAssignmentsForUserRequest)
                                                                                  throws AccessDeniedException,
InvalidParameterValueException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
ConcurrentUpdatingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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 variant of listIAMPolicyAssignmentsForUser(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsForUserIterable responses = client.listIAMPolicyAssignmentsForUserPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsForUserIterable responses = client
             .listIAMPolicyAssignmentsForUserPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsForUserIterable responses = client.listIAMPolicyAssignmentsForUserPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listIAMPolicyAssignmentsForUserPaginator

default ListIAMPolicyAssignmentsForUserIterable listIAMPolicyAssignmentsForUserPaginator(Consumer<ListIamPolicyAssignmentsForUserRequest.Builder> listIamPolicyAssignmentsForUserRequest)
                                                                                  throws AccessDeniedException,
InvalidParameterValueException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
ConcurrentUpdatingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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 variant of listIAMPolicyAssignmentsForUser(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsForUserIterable responses = client.listIAMPolicyAssignmentsForUserPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsForUserIterable responses = client
             .listIAMPolicyAssignmentsForUserPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsForUserIterable responses = client.listIAMPolicyAssignmentsForUserPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListIamPolicyAssignmentsForUserRequest.builder()

Parameters:

listIamPolicyAssignmentsForUserRequest - A Consumer that will call methods on ListIamPolicyAssignmentsForUserRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listIngestions

default ListIngestionsResponse listIngestions(ListIngestionsRequest listIngestionsRequest)
                                       throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
ResourceExistsException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists the history of SPICE ingestions for a dataset.

Parameters:

listIngestionsRequest -

Returns:

Result of the ListIngestions operation returned by the service.

See Also:

• AWS API Documentation

listIngestions

default ListIngestionsResponse listIngestions(Consumer<ListIngestionsRequest.Builder> listIngestionsRequest)
                                       throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
ResourceExistsException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists the history of SPICE ingestions for a dataset.

This is a convenience which creates an instance of the ListIngestionsRequest.Builder avoiding the need to create one manually via ListIngestionsRequest.builder()

Parameters:

listIngestionsRequest - A Consumer that will call methods on ListIngestionsRequest.Builder to create a request.

Returns:

Result of the ListIngestions operation returned by the service.

See Also:

• AWS API Documentation

listIngestionsPaginator

default ListIngestionsIterable listIngestionsPaginator(ListIngestionsRequest listIngestionsRequest)
                                                throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
ResourceExistsException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists the history of SPICE ingestions for a dataset.

This is a variant of listIngestions(software.amazon.awssdk.services.quicksight.model.ListIngestionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListIngestionsIterable responses = client.listIngestionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListIngestionsIterable responses = client
             .listIngestionsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListIngestionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListIngestionsIterable responses = client.listIngestionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listIngestionsPaginator

default ListIngestionsIterable listIngestionsPaginator(Consumer<ListIngestionsRequest.Builder> listIngestionsRequest)
                                                throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
ResourceExistsException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists the history of SPICE ingestions for a dataset.

This is a variant of listIngestions(software.amazon.awssdk.services.quicksight.model.ListIngestionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListIngestionsIterable responses = client.listIngestionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListIngestionsIterable responses = client
             .listIngestionsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListIngestionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListIngestionsIterable responses = client.listIngestionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListIngestionsRequest.builder()

Parameters:

listIngestionsRequest - A Consumer that will call methods on ListIngestionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listNamespaces

default ListNamespacesResponse listNamespaces(ListNamespacesRequest listNamespacesRequest)
                                       throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.

Parameters:

listNamespacesRequest -

Returns:

Result of the ListNamespaces operation returned by the service.

See Also:

• AWS API Documentation

listNamespaces

default ListNamespacesResponse listNamespaces(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest)
                                       throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

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.Builder avoiding the need to create one manually via ListNamespacesRequest.builder()

Parameters:

listNamespacesRequest - A Consumer that will call methods on ListNamespacesRequest.Builder to create a request.

Returns:

Result of the ListNamespaces operation returned by the service.

See Also:

• AWS API Documentation

listNamespacesPaginator

default ListNamespacesIterable listNamespacesPaginator(ListNamespacesRequest listNamespacesRequest)
                                                throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.

This is a variant of listNamespaces(software.amazon.awssdk.services.quicksight.model.ListNamespacesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListNamespacesIterable responses = client.listNamespacesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListNamespacesIterable responses = client
             .listNamespacesPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListNamespacesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListNamespacesIterable responses = client.listNamespacesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listNamespacesPaginator

default ListNamespacesIterable listNamespacesPaginator(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest)
                                                throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.

This is a variant of listNamespaces(software.amazon.awssdk.services.quicksight.model.ListNamespacesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListNamespacesIterable responses = client.listNamespacesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListNamespacesIterable responses = client
             .listNamespacesPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListNamespacesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListNamespacesIterable responses = client.listNamespacesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListNamespacesRequest.builder()

Parameters:

listNamespacesRequest - A Consumer that will call methods on ListNamespacesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listRefreshSchedules

default ListRefreshSchedulesResponse listRefreshSchedules(ListRefreshSchedulesRequest listRefreshSchedulesRequest)
                                                   throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.

Parameters:

listRefreshSchedulesRequest -

Returns:

Result of the ListRefreshSchedules operation returned by the service.

See Also:

• AWS API Documentation

listRefreshSchedules

default ListRefreshSchedulesResponse listRefreshSchedules(Consumer<ListRefreshSchedulesRequest.Builder> listRefreshSchedulesRequest)
                                                   throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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.Builder avoiding the need to create one manually via ListRefreshSchedulesRequest.builder()

Parameters:

listRefreshSchedulesRequest - A Consumer that will call methods on ListRefreshSchedulesRequest.Builder to create a request.

Returns:

Result of the ListRefreshSchedules operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists the tags assigned to a resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists the tags assigned to a resource.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTemplateAliases

default ListTemplateAliasesResponse listTemplateAliases(ListTemplateAliasesRequest listTemplateAliasesRequest)
                                                 throws InvalidNextTokenException,
ThrottlingException,
ResourceNotFoundException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all the aliases of a template.

Parameters:

listTemplateAliasesRequest -

Returns:

Result of the ListTemplateAliases operation returned by the service.

See Also:

• AWS API Documentation

listTemplateAliases

default ListTemplateAliasesResponse listTemplateAliases(Consumer<ListTemplateAliasesRequest.Builder> listTemplateAliasesRequest)
                                                 throws InvalidNextTokenException,
ThrottlingException,
ResourceNotFoundException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all the aliases of a template.

This is a convenience which creates an instance of the ListTemplateAliasesRequest.Builder avoiding the need to create one manually via ListTemplateAliasesRequest.builder()

Parameters:

listTemplateAliasesRequest - A Consumer that will call methods on ListTemplateAliasesRequest.Builder to create a request.

Returns:

Result of the ListTemplateAliases operation returned by the service.

See Also:

• AWS API Documentation

listTemplateAliasesPaginator

default ListTemplateAliasesIterable listTemplateAliasesPaginator(ListTemplateAliasesRequest listTemplateAliasesRequest)
                                                          throws InvalidNextTokenException,
ThrottlingException,
ResourceNotFoundException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all the aliases of a template.

This is a variant of listTemplateAliases(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesIterable responses = client.listTemplateAliasesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesIterable responses = client
             .listTemplateAliasesPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesIterable responses = client.listTemplateAliasesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTemplateAliasesPaginator

default ListTemplateAliasesIterable listTemplateAliasesPaginator(Consumer<ListTemplateAliasesRequest.Builder> listTemplateAliasesRequest)
                                                          throws InvalidNextTokenException,
ThrottlingException,
ResourceNotFoundException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all the aliases of a template.

This is a variant of listTemplateAliases(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesIterable responses = client.listTemplateAliasesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesIterable responses = client
             .listTemplateAliasesPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesIterable responses = client.listTemplateAliasesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListTemplateAliasesRequest.builder()

Parameters:

listTemplateAliasesRequest - A Consumer that will call methods on ListTemplateAliasesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTemplateVersions

default ListTemplateVersionsResponse listTemplateVersions(ListTemplateVersionsRequest listTemplateVersionsRequest)
                                                   throws ThrottlingException,
InvalidParameterValueException,
ResourceNotFoundException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all the versions of the templates in the current Amazon QuickSight account.

Parameters:

listTemplateVersionsRequest -

Returns:

Result of the ListTemplateVersions operation returned by the service.

See Also:

• AWS API Documentation

listTemplateVersions

default ListTemplateVersionsResponse listTemplateVersions(Consumer<ListTemplateVersionsRequest.Builder> listTemplateVersionsRequest)
                                                   throws ThrottlingException,
InvalidParameterValueException,
ResourceNotFoundException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all the versions of the templates in the current Amazon QuickSight account.

This is a convenience which creates an instance of the ListTemplateVersionsRequest.Builder avoiding the need to create one manually via ListTemplateVersionsRequest.builder()

Parameters:

listTemplateVersionsRequest - A Consumer that will call methods on ListTemplateVersionsRequest.Builder to create a request.

Returns:

Result of the ListTemplateVersions operation returned by the service.

See Also:

• AWS API Documentation

listTemplateVersionsPaginator

default ListTemplateVersionsIterable listTemplateVersionsPaginator(ListTemplateVersionsRequest listTemplateVersionsRequest)
                                                            throws ThrottlingException,
InvalidParameterValueException,
ResourceNotFoundException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all the versions of the templates in the current Amazon QuickSight account.

This is a variant of listTemplateVersions(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsIterable responses = client.listTemplateVersionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsIterable responses = client
             .listTemplateVersionsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsIterable responses = client.listTemplateVersionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTemplateVersionsPaginator

default ListTemplateVersionsIterable listTemplateVersionsPaginator(Consumer<ListTemplateVersionsRequest.Builder> listTemplateVersionsRequest)
                                                            throws ThrottlingException,
InvalidParameterValueException,
ResourceNotFoundException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all the versions of the templates in the current Amazon QuickSight account.

This is a variant of listTemplateVersions(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsIterable responses = client.listTemplateVersionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsIterable responses = client
             .listTemplateVersionsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsIterable responses = client.listTemplateVersionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListTemplateVersionsRequest.builder()

Parameters:

listTemplateVersionsRequest - A Consumer that will call methods on ListTemplateVersionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTemplates

default ListTemplatesResponse listTemplates(ListTemplatesRequest listTemplatesRequest)
                                     throws ThrottlingException,
InvalidParameterValueException,
ResourceNotFoundException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all the templates in the current Amazon QuickSight account.

Parameters:

listTemplatesRequest -

Returns:

Result of the ListTemplates operation returned by the service.

See Also:

• AWS API Documentation

listTemplates

default ListTemplatesResponse listTemplates(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest)
                                     throws ThrottlingException,
InvalidParameterValueException,
ResourceNotFoundException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all the templates in the current Amazon QuickSight account.

This is a convenience which creates an instance of the ListTemplatesRequest.Builder avoiding the need to create one manually via ListTemplatesRequest.builder()

Parameters:

listTemplatesRequest - A Consumer that will call methods on ListTemplatesRequest.Builder to create a request.

Returns:

Result of the ListTemplates operation returned by the service.

See Also:

• AWS API Documentation

listTemplatesPaginator

default ListTemplatesIterable listTemplatesPaginator(ListTemplatesRequest listTemplatesRequest)
                                              throws ThrottlingException,
InvalidParameterValueException,
ResourceNotFoundException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all the templates in the current Amazon QuickSight account.

This is a variant of listTemplates(software.amazon.awssdk.services.quicksight.model.ListTemplatesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListTemplatesIterable responses = client
             .listTemplatesPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListTemplatesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTemplatesPaginator

default ListTemplatesIterable listTemplatesPaginator(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest)
                                              throws ThrottlingException,
InvalidParameterValueException,
ResourceNotFoundException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all the templates in the current Amazon QuickSight account.

This is a variant of listTemplates(software.amazon.awssdk.services.quicksight.model.ListTemplatesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListTemplatesIterable responses = client
             .listTemplatesPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListTemplatesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListTemplatesRequest.builder()

Parameters:

listTemplatesRequest - A Consumer that will call methods on ListTemplatesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listThemeAliases

default ListThemeAliasesResponse listThemeAliases(ListThemeAliasesRequest listThemeAliasesRequest)
                                           throws ConflictException,
InvalidNextTokenException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all the aliases of a theme.

Parameters:

listThemeAliasesRequest -

Returns:

Result of the ListThemeAliases operation returned by the service.

See Also:

• AWS API Documentation

listThemeAliases

default ListThemeAliasesResponse listThemeAliases(Consumer<ListThemeAliasesRequest.Builder> listThemeAliasesRequest)
                                           throws ConflictException,
InvalidNextTokenException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all the aliases of a theme.

This is a convenience which creates an instance of the ListThemeAliasesRequest.Builder avoiding the need to create one manually via ListThemeAliasesRequest.builder()

Parameters:

listThemeAliasesRequest - A Consumer that will call methods on ListThemeAliasesRequest.Builder to create a request.

Returns:

Result of the ListThemeAliases operation returned by the service.

See Also:

• AWS API Documentation

listThemeVersions

default ListThemeVersionsResponse listThemeVersions(ListThemeVersionsRequest listThemeVersionsRequest)
                                             throws AccessDeniedException,
InvalidNextTokenException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all the versions of the themes in the current Amazon Web Services account.

Parameters:

listThemeVersionsRequest -

Returns:

Result of the ListThemeVersions operation returned by the service.

See Also:

• AWS API Documentation

listThemeVersions

default ListThemeVersionsResponse listThemeVersions(Consumer<ListThemeVersionsRequest.Builder> listThemeVersionsRequest)
                                             throws AccessDeniedException,
InvalidNextTokenException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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.Builder avoiding the need to create one manually via ListThemeVersionsRequest.builder()

Parameters:

listThemeVersionsRequest - A Consumer that will call methods on ListThemeVersionsRequest.Builder to create a request.

Returns:

Result of the ListThemeVersions operation returned by the service.

See Also:

• AWS API Documentation

listThemeVersionsPaginator

default ListThemeVersionsIterable listThemeVersionsPaginator(ListThemeVersionsRequest listThemeVersionsRequest)
                                                      throws AccessDeniedException,
InvalidNextTokenException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all the versions of the themes in the current Amazon Web Services account.

This is a variant of listThemeVersions(software.amazon.awssdk.services.quicksight.model.ListThemeVersionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListThemeVersionsIterable responses = client.listThemeVersionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListThemeVersionsIterable responses = client
             .listThemeVersionsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListThemeVersionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListThemeVersionsIterable responses = client.listThemeVersionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listThemeVersionsPaginator

default ListThemeVersionsIterable listThemeVersionsPaginator(Consumer<ListThemeVersionsRequest.Builder> listThemeVersionsRequest)
                                                      throws AccessDeniedException,
InvalidNextTokenException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all the versions of the themes in the current Amazon Web Services account.

This is a variant of listThemeVersions(software.amazon.awssdk.services.quicksight.model.ListThemeVersionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListThemeVersionsIterable responses = client.listThemeVersionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListThemeVersionsIterable responses = client
             .listThemeVersionsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListThemeVersionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListThemeVersionsIterable responses = client.listThemeVersionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListThemeVersionsRequest.builder()

Parameters:

listThemeVersionsRequest - A Consumer that will call methods on ListThemeVersionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listThemes

default ListThemesResponse listThemes(ListThemesRequest listThemesRequest)
                               throws AccessDeniedException,
InvalidParameterValueException,
InvalidNextTokenException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all the themes in the current Amazon Web Services account.

Parameters:

listThemesRequest -

Returns:

Result of the ListThemes operation returned by the service.

See Also:

• AWS API Documentation

listThemes

default ListThemesResponse listThemes(Consumer<ListThemesRequest.Builder> listThemesRequest)
                               throws AccessDeniedException,
InvalidParameterValueException,
InvalidNextTokenException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all the themes in the current Amazon Web Services account.

This is a convenience which creates an instance of the ListThemesRequest.Builder avoiding the need to create one manually via ListThemesRequest.builder()

Parameters:

listThemesRequest - A Consumer that will call methods on ListThemesRequest.Builder to create a request.

Returns:

Result of the ListThemes operation returned by the service.

See Also:

• AWS API Documentation

listThemesPaginator

default ListThemesIterable listThemesPaginator(ListThemesRequest listThemesRequest)
                                        throws AccessDeniedException,
InvalidParameterValueException,
InvalidNextTokenException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all the themes in the current Amazon Web Services account.

This is a variant of listThemes(software.amazon.awssdk.services.quicksight.model.ListThemesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListThemesIterable responses = client.listThemesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListThemesIterable responses = client.listThemesPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListThemesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListThemesIterable responses = client.listThemesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listThemesPaginator

default ListThemesIterable listThemesPaginator(Consumer<ListThemesRequest.Builder> listThemesRequest)
                                        throws AccessDeniedException,
InvalidParameterValueException,
InvalidNextTokenException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all the themes in the current Amazon Web Services account.

This is a variant of listThemes(software.amazon.awssdk.services.quicksight.model.ListThemesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListThemesIterable responses = client.listThemesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListThemesIterable responses = client.listThemesPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListThemesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListThemesIterable responses = client.listThemesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListThemesRequest.builder()

Parameters:

listThemesRequest - A Consumer that will call methods on ListThemesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTopicRefreshSchedules

default ListTopicRefreshSchedulesResponse listTopicRefreshSchedules(ListTopicRefreshSchedulesRequest listTopicRefreshSchedulesRequest)
                                                             throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
LimitExceededException,
ResourceNotFoundException,
ResourceExistsException,
ThrottlingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all of the refresh schedules for a topic.

Parameters:

listTopicRefreshSchedulesRequest -

Returns:

Result of the ListTopicRefreshSchedules operation returned by the service.

See Also:

• AWS API Documentation

listTopicRefreshSchedules

default ListTopicRefreshSchedulesResponse listTopicRefreshSchedules(Consumer<ListTopicRefreshSchedulesRequest.Builder> listTopicRefreshSchedulesRequest)
                                                             throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
LimitExceededException,
ResourceNotFoundException,
ResourceExistsException,
ThrottlingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all of the refresh schedules for a topic.

This is a convenience which creates an instance of the ListTopicRefreshSchedulesRequest.Builder avoiding the need to create one manually via ListTopicRefreshSchedulesRequest.builder()

Parameters:

listTopicRefreshSchedulesRequest - A Consumer that will call methods on ListTopicRefreshSchedulesRequest.Builder to create a request.

Returns:

Result of the ListTopicRefreshSchedules operation returned by the service.

See Also:

• AWS API Documentation

listTopics

default ListTopicsResponse listTopics(ListTopicsRequest listTopicsRequest)
                               throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all of the topics within an account.

Parameters:

listTopicsRequest -

Returns:

Result of the ListTopics operation returned by the service.

See Also:

• AWS API Documentation

listTopics

default ListTopicsResponse listTopics(Consumer<ListTopicsRequest.Builder> listTopicsRequest)
                               throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all of the topics within an account.

This is a convenience which creates an instance of the ListTopicsRequest.Builder avoiding the need to create one manually via ListTopicsRequest.builder()

Parameters:

listTopicsRequest - A Consumer that will call methods on ListTopicsRequest.Builder to create a request.

Returns:

Result of the ListTopics operation returned by the service.

See Also:

• AWS API Documentation

listTopicsPaginator

default ListTopicsIterable listTopicsPaginator(ListTopicsRequest listTopicsRequest)
                                        throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all of the topics within an account.

This is a variant of listTopics(software.amazon.awssdk.services.quicksight.model.ListTopicsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListTopicsIterable responses = client.listTopicsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListTopicsIterable responses = client.listTopicsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListTopicsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListTopicsIterable responses = client.listTopicsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTopicsPaginator

default ListTopicsIterable listTopicsPaginator(Consumer<ListTopicsRequest.Builder> listTopicsRequest)
                                        throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all of the topics within an account.

This is a variant of listTopics(software.amazon.awssdk.services.quicksight.model.ListTopicsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListTopicsIterable responses = client.listTopicsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListTopicsIterable responses = client.listTopicsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListTopicsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListTopicsIterable responses = client.listTopicsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListTopicsRequest.builder()

Parameters:

listTopicsRequest - A Consumer that will call methods on ListTopicsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listUserGroups

default ListUserGroupsResponse listUserGroups(ListUserGroupsRequest listUserGroupsRequest)
                                       throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.

Parameters:

listUserGroupsRequest -

Returns:

Result of the ListUserGroups operation returned by the service.

See Also:

• AWS API Documentation

listUserGroups

default ListUserGroupsResponse listUserGroups(Consumer<ListUserGroupsRequest.Builder> listUserGroupsRequest)
                                       throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.

This is a convenience which creates an instance of the ListUserGroupsRequest.Builder avoiding the need to create one manually via ListUserGroupsRequest.builder()

Parameters:

listUserGroupsRequest - A Consumer that will call methods on ListUserGroupsRequest.Builder to create a request.

Returns:

Result of the ListUserGroups operation returned by the service.

See Also:

• AWS API Documentation

listUserGroupsPaginator

default ListUserGroupsIterable listUserGroupsPaginator(ListUserGroupsRequest listUserGroupsRequest)
                                                throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.

This is a variant of listUserGroups(software.amazon.awssdk.services.quicksight.model.ListUserGroupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListUserGroupsIterable responses = client.listUserGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListUserGroupsIterable responses = client
             .listUserGroupsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListUserGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListUserGroupsIterable responses = client.listUserGroupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listUserGroupsPaginator

default ListUserGroupsIterable listUserGroupsPaginator(Consumer<ListUserGroupsRequest.Builder> listUserGroupsRequest)
                                                throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.

This is a variant of listUserGroups(software.amazon.awssdk.services.quicksight.model.ListUserGroupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListUserGroupsIterable responses = client.listUserGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListUserGroupsIterable responses = client
             .listUserGroupsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListUserGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListUserGroupsIterable responses = client.listUserGroupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListUserGroupsRequest.builder()

Parameters:

listUserGroupsRequest - A Consumer that will call methods on ListUserGroupsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listUsers

default ListUsersResponse listUsers(ListUsersRequest listUsersRequest)
                             throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Returns a list of all of the Amazon QuickSight users belonging to this account.

Parameters:

listUsersRequest -

Returns:

Result of the ListUsers operation returned by the service.

See Also:

• AWS API Documentation

listUsers

default ListUsersResponse listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
                             throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Returns a list of all of the Amazon QuickSight users belonging to this account.

This is a convenience which creates an instance of the ListUsersRequest.Builder avoiding the need to create one manually via ListUsersRequest.builder()

Parameters:

listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.

Returns:

Result of the ListUsers operation returned by the service.

See Also:

• AWS API Documentation

listUsersPaginator

default ListUsersIterable listUsersPaginator(ListUsersRequest listUsersRequest)
                                      throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Returns a list of all of the Amazon QuickSight users belonging to this account.

This is a variant of listUsers(software.amazon.awssdk.services.quicksight.model.ListUsersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListUsersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listUsersPaginator

default ListUsersIterable listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)
                                      throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Returns a list of all of the Amazon QuickSight users belonging to this account.

This is a variant of listUsers(software.amazon.awssdk.services.quicksight.model.ListUsersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListUsersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListUsersIterable responses = client.listUsersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListUsersRequest.builder()

Parameters:

listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listVPCConnections

default ListVpcConnectionsResponse listVPCConnections(ListVpcConnectionsRequest listVpcConnectionsRequest)
                                               throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.

Parameters:

listVpcConnectionsRequest -

Returns:

Result of the ListVPCConnections operation returned by the service.

See Also:

• AWS API Documentation

listVPCConnections

default ListVpcConnectionsResponse listVPCConnections(Consumer<ListVpcConnectionsRequest.Builder> listVpcConnectionsRequest)
                                               throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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.Builder avoiding the need to create one manually via ListVpcConnectionsRequest.builder()

Parameters:

listVpcConnectionsRequest - A Consumer that will call methods on ListVpcConnectionsRequest.Builder to create a request.

Returns:

Result of the ListVPCConnections operation returned by the service.

See Also:

• AWS API Documentation

listVPCConnectionsPaginator

default ListVPCConnectionsIterable listVPCConnectionsPaginator(ListVpcConnectionsRequest listVpcConnectionsRequest)
                                                        throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.

This is a variant of listVPCConnections(software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListVPCConnectionsIterable responses = client.listVPCConnectionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListVPCConnectionsIterable responses = client
             .listVPCConnectionsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListVPCConnectionsIterable responses = client.listVPCConnectionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listVPCConnectionsPaginator

default ListVPCConnectionsIterable listVPCConnectionsPaginator(Consumer<ListVpcConnectionsRequest.Builder> listVpcConnectionsRequest)
                                                        throws AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.

This is a variant of listVPCConnections(software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.ListVPCConnectionsIterable responses = client.listVPCConnectionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.ListVPCConnectionsIterable responses = client
             .listVPCConnectionsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.ListVPCConnectionsIterable responses = client.listVPCConnectionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListVpcConnectionsRequest.builder()

Parameters:

listVpcConnectionsRequest - A Consumer that will call methods on ListVpcConnectionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

putDataSetRefreshProperties

default PutDataSetRefreshPropertiesResponse putDataSetRefreshProperties(PutDataSetRefreshPropertiesRequest putDataSetRefreshPropertiesRequest)
                                                                 throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
PreconditionNotMetException,
ConflictException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates or updates the dataset refresh properties for the dataset.

Parameters:

putDataSetRefreshPropertiesRequest -

Returns:

Result of the PutDataSetRefreshProperties operation returned by the service.

See Also:

• AWS API Documentation

putDataSetRefreshProperties

default PutDataSetRefreshPropertiesResponse putDataSetRefreshProperties(Consumer<PutDataSetRefreshPropertiesRequest.Builder> putDataSetRefreshPropertiesRequest)
                                                                 throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
PreconditionNotMetException,
ConflictException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates or updates the dataset refresh properties for the dataset.

This is a convenience which creates an instance of the PutDataSetRefreshPropertiesRequest.Builder avoiding the need to create one manually via PutDataSetRefreshPropertiesRequest.builder()

Parameters:

putDataSetRefreshPropertiesRequest - A Consumer that will call methods on PutDataSetRefreshPropertiesRequest.Builder to create a request.

Returns:

Result of the PutDataSetRefreshProperties operation returned by the service.

See Also:

• AWS API Documentation

registerUser

default RegisterUserResponse registerUser(RegisterUserRequest registerUserRequest)
                                   throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
ResourceExistsException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see Inviting users to access Amazon QuickSight.

Parameters:

registerUserRequest -

Returns:

Result of the RegisterUser operation returned by the service.

See Also:

• AWS API Documentation

registerUser

default RegisterUserResponse registerUser(Consumer<RegisterUserRequest.Builder> registerUserRequest)
                                   throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
ResourceExistsException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see Inviting users to access Amazon QuickSight.

This is a convenience which creates an instance of the RegisterUserRequest.Builder avoiding the need to create one manually via RegisterUserRequest.builder()

Parameters:

registerUserRequest - A Consumer that will call methods on RegisterUserRequest.Builder to create a request.

Returns:

Result of the RegisterUser operation returned by the service.

See Also:

• AWS API Documentation

restoreAnalysis

default RestoreAnalysisResponse restoreAnalysis(RestoreAnalysisRequest restoreAnalysisRequest)
                                         throws ThrottlingException,
InvalidParameterValueException,
ConflictException,
ResourceNotFoundException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Restores an analysis.

Parameters:

restoreAnalysisRequest -

Returns:

Result of the RestoreAnalysis operation returned by the service.

See Also:

• AWS API Documentation

restoreAnalysis

default RestoreAnalysisResponse restoreAnalysis(Consumer<RestoreAnalysisRequest.Builder> restoreAnalysisRequest)
                                         throws ThrottlingException,
InvalidParameterValueException,
ConflictException,
ResourceNotFoundException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Restores an analysis.

This is a convenience which creates an instance of the RestoreAnalysisRequest.Builder avoiding the need to create one manually via RestoreAnalysisRequest.builder()

Parameters:

restoreAnalysisRequest - A Consumer that will call methods on RestoreAnalysisRequest.Builder to create a request.

Returns:

Result of the RestoreAnalysis operation returned by the service.

See Also:

• AWS API Documentation

searchAnalyses

default SearchAnalysesResponse searchAnalyses(SearchAnalysesRequest searchAnalysesRequest)
                                       throws ThrottlingException,
ResourceNotFoundException,
InvalidParameterValueException,
UnsupportedUserEditionException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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:

Result of the SearchAnalyses operation returned by the service.

See Also:

• AWS API Documentation

searchAnalyses

default SearchAnalysesResponse searchAnalyses(Consumer<SearchAnalysesRequest.Builder> searchAnalysesRequest)
                                       throws ThrottlingException,
ResourceNotFoundException,
InvalidParameterValueException,
UnsupportedUserEditionException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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.Builder avoiding the need to create one manually via SearchAnalysesRequest.builder()

Parameters:

searchAnalysesRequest - A Consumer that will call methods on SearchAnalysesRequest.Builder to create a request.

Returns:

Result of the SearchAnalyses operation returned by the service.

See Also:

• AWS API Documentation

searchAnalysesPaginator

default SearchAnalysesIterable searchAnalysesPaginator(SearchAnalysesRequest searchAnalysesRequest)
                                                throws ThrottlingException,
ResourceNotFoundException,
InvalidParameterValueException,
UnsupportedUserEditionException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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 variant of searchAnalyses(software.amazon.awssdk.services.quicksight.model.SearchAnalysesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.SearchAnalysesIterable responses = client.searchAnalysesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.SearchAnalysesIterable responses = client
             .searchAnalysesPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.SearchAnalysesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.SearchAnalysesIterable responses = client.searchAnalysesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

searchAnalysesPaginator

default SearchAnalysesIterable searchAnalysesPaginator(Consumer<SearchAnalysesRequest.Builder> searchAnalysesRequest)
                                                throws ThrottlingException,
ResourceNotFoundException,
InvalidParameterValueException,
UnsupportedUserEditionException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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 variant of searchAnalyses(software.amazon.awssdk.services.quicksight.model.SearchAnalysesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.SearchAnalysesIterable responses = client.searchAnalysesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.SearchAnalysesIterable responses = client
             .searchAnalysesPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.SearchAnalysesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.SearchAnalysesIterable responses = client.searchAnalysesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via SearchAnalysesRequest.builder()

Parameters:

searchAnalysesRequest - A Consumer that will call methods on SearchAnalysesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

searchDashboards

default SearchDashboardsResponse searchDashboards(SearchDashboardsRequest searchDashboardsRequest)
                                           throws ThrottlingException,
ResourceNotFoundException,
InvalidParameterValueException,
UnsupportedUserEditionException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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:

Result of the SearchDashboards operation returned by the service.

See Also:

• AWS API Documentation

searchDashboards

default SearchDashboardsResponse searchDashboards(Consumer<SearchDashboardsRequest.Builder> searchDashboardsRequest)
                                           throws ThrottlingException,
ResourceNotFoundException,
InvalidParameterValueException,
UnsupportedUserEditionException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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.Builder avoiding the need to create one manually via SearchDashboardsRequest.builder()

Parameters:

searchDashboardsRequest - A Consumer that will call methods on SearchDashboardsRequest.Builder to create a request.

Returns:

Result of the SearchDashboards operation returned by the service.

See Also:

• AWS API Documentation

searchDashboardsPaginator

default SearchDashboardsIterable searchDashboardsPaginator(SearchDashboardsRequest searchDashboardsRequest)
                                                    throws ThrottlingException,
ResourceNotFoundException,
InvalidParameterValueException,
UnsupportedUserEditionException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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 variant of searchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsIterable responses = client.searchDashboardsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsIterable responses = client
             .searchDashboardsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.SearchDashboardsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsIterable responses = client.searchDashboardsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

searchDashboardsPaginator

default SearchDashboardsIterable searchDashboardsPaginator(Consumer<SearchDashboardsRequest.Builder> searchDashboardsRequest)
                                                    throws ThrottlingException,
ResourceNotFoundException,
InvalidParameterValueException,
UnsupportedUserEditionException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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 variant of searchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsIterable responses = client.searchDashboardsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsIterable responses = client
             .searchDashboardsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.SearchDashboardsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsIterable responses = client.searchDashboardsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via SearchDashboardsRequest.builder()

Parameters:

searchDashboardsRequest - A Consumer that will call methods on SearchDashboardsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

searchDataSets

default SearchDataSetsResponse searchDataSets(SearchDataSetsRequest searchDataSetsRequest)
                                       throws ThrottlingException,
ResourceNotFoundException,
InvalidParameterValueException,
AccessDeniedException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Use the SearchDataSets operation to search for datasets that belong to an account.

Parameters:

searchDataSetsRequest -

Returns:

Result of the SearchDataSets operation returned by the service.

See Also:

• AWS API Documentation

searchDataSets

default SearchDataSetsResponse searchDataSets(Consumer<SearchDataSetsRequest.Builder> searchDataSetsRequest)
                                       throws ThrottlingException,
ResourceNotFoundException,
InvalidParameterValueException,
AccessDeniedException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Use the SearchDataSets operation to search for datasets that belong to an account.

This is a convenience which creates an instance of the SearchDataSetsRequest.Builder avoiding the need to create one manually via SearchDataSetsRequest.builder()

Parameters:

searchDataSetsRequest - A Consumer that will call methods on SearchDataSetsRequest.Builder to create a request.

Returns:

Result of the SearchDataSets operation returned by the service.

See Also:

• AWS API Documentation

searchDataSetsPaginator

default SearchDataSetsIterable searchDataSetsPaginator(SearchDataSetsRequest searchDataSetsRequest)
                                                throws ThrottlingException,
ResourceNotFoundException,
InvalidParameterValueException,
AccessDeniedException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Use the SearchDataSets operation to search for datasets that belong to an account.

This is a variant of searchDataSets(software.amazon.awssdk.services.quicksight.model.SearchDataSetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.SearchDataSetsIterable responses = client.searchDataSetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.SearchDataSetsIterable responses = client
             .searchDataSetsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.SearchDataSetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.SearchDataSetsIterable responses = client.searchDataSetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

searchDataSetsPaginator

default SearchDataSetsIterable searchDataSetsPaginator(Consumer<SearchDataSetsRequest.Builder> searchDataSetsRequest)
                                                throws ThrottlingException,
ResourceNotFoundException,
InvalidParameterValueException,
AccessDeniedException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Use the SearchDataSets operation to search for datasets that belong to an account.

This is a variant of searchDataSets(software.amazon.awssdk.services.quicksight.model.SearchDataSetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.SearchDataSetsIterable responses = client.searchDataSetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.SearchDataSetsIterable responses = client
             .searchDataSetsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.SearchDataSetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.SearchDataSetsIterable responses = client.searchDataSetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via SearchDataSetsRequest.builder()

Parameters:

searchDataSetsRequest - A Consumer that will call methods on SearchDataSetsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

searchDataSources

default SearchDataSourcesResponse searchDataSources(SearchDataSourcesRequest searchDataSourcesRequest)
                                             throws ThrottlingException,
ResourceNotFoundException,
InvalidParameterValueException,
AccessDeniedException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Use the SearchDataSources operation to search for data sources that belong to an account.

Parameters:

searchDataSourcesRequest -

Returns:

Result of the SearchDataSources operation returned by the service.

See Also:

• AWS API Documentation

searchDataSources

default SearchDataSourcesResponse searchDataSources(Consumer<SearchDataSourcesRequest.Builder> searchDataSourcesRequest)
                                             throws ThrottlingException,
ResourceNotFoundException,
InvalidParameterValueException,
AccessDeniedException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Use the SearchDataSources operation to search for data sources that belong to an account.

This is a convenience which creates an instance of the SearchDataSourcesRequest.Builder avoiding the need to create one manually via SearchDataSourcesRequest.builder()

Parameters:

searchDataSourcesRequest - A Consumer that will call methods on SearchDataSourcesRequest.Builder to create a request.

Returns:

Result of the SearchDataSources operation returned by the service.

See Also:

• AWS API Documentation

searchDataSourcesPaginator

default SearchDataSourcesIterable searchDataSourcesPaginator(SearchDataSourcesRequest searchDataSourcesRequest)
                                                      throws ThrottlingException,
ResourceNotFoundException,
InvalidParameterValueException,
AccessDeniedException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Use the SearchDataSources operation to search for data sources that belong to an account.

This is a variant of searchDataSources(software.amazon.awssdk.services.quicksight.model.SearchDataSourcesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.SearchDataSourcesIterable responses = client.searchDataSourcesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.SearchDataSourcesIterable responses = client
             .searchDataSourcesPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.SearchDataSourcesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.SearchDataSourcesIterable responses = client.searchDataSourcesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

searchDataSourcesPaginator

default SearchDataSourcesIterable searchDataSourcesPaginator(Consumer<SearchDataSourcesRequest.Builder> searchDataSourcesRequest)
                                                      throws ThrottlingException,
ResourceNotFoundException,
InvalidParameterValueException,
AccessDeniedException,
InvalidNextTokenException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Use the SearchDataSources operation to search for data sources that belong to an account.

This is a variant of searchDataSources(software.amazon.awssdk.services.quicksight.model.SearchDataSourcesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.SearchDataSourcesIterable responses = client.searchDataSourcesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.SearchDataSourcesIterable responses = client
             .searchDataSourcesPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.SearchDataSourcesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.SearchDataSourcesIterable responses = client.searchDataSourcesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via SearchDataSourcesRequest.builder()

Parameters:

searchDataSourcesRequest - A Consumer that will call methods on SearchDataSourcesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

searchFolders

default SearchFoldersResponse searchFolders(SearchFoldersRequest searchFoldersRequest)
                                     throws InvalidParameterValueException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InvalidRequestException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Searches the subfolders in a folder.

Parameters:

searchFoldersRequest -

Returns:

Result of the SearchFolders operation returned by the service.

See Also:

• AWS API Documentation

searchFolders

default SearchFoldersResponse searchFolders(Consumer<SearchFoldersRequest.Builder> searchFoldersRequest)
                                     throws InvalidParameterValueException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InvalidRequestException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Searches the subfolders in a folder.

This is a convenience which creates an instance of the SearchFoldersRequest.Builder avoiding the need to create one manually via SearchFoldersRequest.builder()

Parameters:

searchFoldersRequest - A Consumer that will call methods on SearchFoldersRequest.Builder to create a request.

Returns:

Result of the SearchFolders operation returned by the service.

See Also:

• AWS API Documentation

searchFoldersPaginator

default SearchFoldersIterable searchFoldersPaginator(SearchFoldersRequest searchFoldersRequest)
                                              throws InvalidParameterValueException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InvalidRequestException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Searches the subfolders in a folder.

This is a variant of searchFolders(software.amazon.awssdk.services.quicksight.model.SearchFoldersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.SearchFoldersIterable responses = client.searchFoldersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.SearchFoldersIterable responses = client
             .searchFoldersPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.SearchFoldersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.SearchFoldersIterable responses = client.searchFoldersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

searchFoldersPaginator

default SearchFoldersIterable searchFoldersPaginator(Consumer<SearchFoldersRequest.Builder> searchFoldersRequest)
                                              throws InvalidParameterValueException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
UnsupportedUserEditionException,
InvalidRequestException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Searches the subfolders in a folder.

This is a variant of searchFolders(software.amazon.awssdk.services.quicksight.model.SearchFoldersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.SearchFoldersIterable responses = client.searchFoldersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.SearchFoldersIterable responses = client
             .searchFoldersPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.SearchFoldersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.SearchFoldersIterable responses = client.searchFoldersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via SearchFoldersRequest.builder()

Parameters:

searchFoldersRequest - A Consumer that will call methods on SearchFoldersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

searchGroups

default SearchGroupsResponse searchGroups(SearchGroupsRequest searchGroupsRequest)
                                   throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.

Parameters:

searchGroupsRequest -

Returns:

Result of the SearchGroups operation returned by the service.

See Also:

• AWS API Documentation

searchGroups

default SearchGroupsResponse searchGroups(Consumer<SearchGroupsRequest.Builder> searchGroupsRequest)
                                   throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.

This is a convenience which creates an instance of the SearchGroupsRequest.Builder avoiding the need to create one manually via SearchGroupsRequest.builder()

Parameters:

searchGroupsRequest - A Consumer that will call methods on SearchGroupsRequest.Builder to create a request.

Returns:

Result of the SearchGroups operation returned by the service.

See Also:

• AWS API Documentation

searchGroupsPaginator

default SearchGroupsIterable searchGroupsPaginator(SearchGroupsRequest searchGroupsRequest)
                                            throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.

This is a variant of searchGroups(software.amazon.awssdk.services.quicksight.model.SearchGroupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.SearchGroupsIterable responses = client.searchGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.SearchGroupsIterable responses = client.searchGroupsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.SearchGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.SearchGroupsIterable responses = client.searchGroupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

searchGroupsPaginator

default SearchGroupsIterable searchGroupsPaginator(Consumer<SearchGroupsRequest.Builder> searchGroupsRequest)
                                            throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InvalidNextTokenException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.

This is a variant of searchGroups(software.amazon.awssdk.services.quicksight.model.SearchGroupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.quicksight.paginators.SearchGroupsIterable responses = client.searchGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.quicksight.paginators.SearchGroupsIterable responses = client.searchGroupsPaginator(request);
     for (software.amazon.awssdk.services.quicksight.model.SearchGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.quicksight.paginators.SearchGroupsIterable responses = client.searchGroupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via SearchGroupsRequest.builder()

Parameters:

searchGroupsRequest - A Consumer that will call methods on SearchGroupsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

startAssetBundleExportJob

default StartAssetBundleExportJobResponse startAssetBundleExportJob(StartAssetBundleExportJobRequest startAssetBundleExportJobRequest)
                                                             throws UnsupportedUserEditionException,
ThrottlingException,
InvalidParameterValueException,
AccessDeniedException,
LimitExceededException,
ConflictException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
QuickSightException

Starts an Asset Bundle export job.

An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon QuickSight account can run up to 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:

Result of the StartAssetBundleExportJob operation returned by the service.

See Also:

• AWS API Documentation

startAssetBundleExportJob

default StartAssetBundleExportJobResponse startAssetBundleExportJob(Consumer<StartAssetBundleExportJobRequest.Builder> startAssetBundleExportJobRequest)
                                                             throws UnsupportedUserEditionException,
ThrottlingException,
InvalidParameterValueException,
AccessDeniedException,
LimitExceededException,
ConflictException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
QuickSightException

Starts an Asset Bundle export job.

An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon QuickSight account can run up to 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.Builder avoiding the need to create one manually via StartAssetBundleExportJobRequest.builder()

Parameters:

startAssetBundleExportJobRequest - A Consumer that will call methods on StartAssetBundleExportJobRequest.Builder to create a request.

Returns:

Result of the StartAssetBundleExportJob operation returned by the service.

See Also:

• AWS API Documentation

startAssetBundleImportJob

default StartAssetBundleImportJobResponse startAssetBundleImportJob(StartAssetBundleImportJobRequest startAssetBundleImportJobRequest)
                                                             throws UnsupportedUserEditionException,
ThrottlingException,
InvalidParameterValueException,
AccessDeniedException,
LimitExceededException,
ConflictException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
QuickSightException

Starts an Asset Bundle import job.

An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 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:

Result of the StartAssetBundleImportJob operation returned by the service.

See Also:

• AWS API Documentation

startAssetBundleImportJob

default StartAssetBundleImportJobResponse startAssetBundleImportJob(Consumer<StartAssetBundleImportJobRequest.Builder> startAssetBundleImportJobRequest)
                                                             throws UnsupportedUserEditionException,
ThrottlingException,
InvalidParameterValueException,
AccessDeniedException,
LimitExceededException,
ConflictException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
QuickSightException

Starts an Asset Bundle import job.

An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 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.Builder avoiding the need to create one manually via StartAssetBundleImportJobRequest.builder()

Parameters:

startAssetBundleImportJobRequest - A Consumer that will call methods on StartAssetBundleImportJobRequest.Builder to create a request.

Returns:

Result of the StartAssetBundleImportJob operation returned by the service.

See Also:

• AWS API Documentation

startDashboardSnapshotJob

default StartDashboardSnapshotJobResponse startDashboardSnapshotJob(StartDashboardSnapshotJobRequest startDashboardSnapshotJobRequest)
                                                             throws AccessDeniedException,
InvalidParameterValueException,
LimitExceededException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
UnsupportedPricingPlanException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Starts an asynchronous job that generates a dashboard snapshot. You can request one of the following format configurations per API call.

• 1 paginated PDF

• 1 Excel workbook

• 5 CSVs

Poll job descriptions with a DescribeDashboardSnapshotJob API call. Once the job succeeds, use the DescribeDashboardSnapshotJobResult API to obtain the download URIs that the job generates.

Parameters:

startDashboardSnapshotJobRequest -

Returns:

Result of the StartDashboardSnapshotJob operation returned by the service.

See Also:

• AWS API Documentation

startDashboardSnapshotJob

default StartDashboardSnapshotJobResponse startDashboardSnapshotJob(Consumer<StartDashboardSnapshotJobRequest.Builder> startDashboardSnapshotJobRequest)
                                                             throws AccessDeniedException,
InvalidParameterValueException,
LimitExceededException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
UnsupportedPricingPlanException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Starts an asynchronous job that generates a dashboard snapshot. You can request one of the following format configurations per API call.

• 1 paginated PDF

• 1 Excel workbook

• 5 CSVs

Poll job descriptions with a DescribeDashboardSnapshotJob API call. Once the job succeeds, use the DescribeDashboardSnapshotJobResult API to obtain the download URIs that the job generates.

This is a convenience which creates an instance of the StartDashboardSnapshotJobRequest.Builder avoiding the need to create one manually via StartDashboardSnapshotJobRequest.builder()

Parameters:

startDashboardSnapshotJobRequest - A Consumer that will call methods on StartDashboardSnapshotJobRequest.Builder to create a request.

Returns:

Result of the StartDashboardSnapshotJob operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws LimitExceededException,
AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, template, topic, and user.

Tagging for Amazon QuickSight 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 QuickSight. You can't tag other resources that Amazon QuickSight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units.

• Amazon QuickSight doesn't currently support the tag editor for Resource Groups.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws LimitExceededException,
AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, template, topic, and user.

Tagging for Amazon QuickSight 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 QuickSight. You can't tag other resources that Amazon QuickSight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units.

• Amazon QuickSight doesn't currently support the tag editor for Resource Groups.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Removes a tag or tags from a resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Removes a tag or tags from a resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateAccountCustomization

default UpdateAccountCustomizationResponse updateAccountCustomization(UpdateAccountCustomizationRequest updateAccountCustomizationRequest)
                                                               throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.

You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.

Parameters:

updateAccountCustomizationRequest -

Returns:

Result of the UpdateAccountCustomization operation returned by the service.

See Also:

• AWS API Documentation

updateAccountCustomization

default UpdateAccountCustomizationResponse updateAccountCustomization(Consumer<UpdateAccountCustomizationRequest.Builder> updateAccountCustomizationRequest)
                                                               throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.

You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.

This is a convenience which creates an instance of the UpdateAccountCustomizationRequest.Builder avoiding the need to create one manually via UpdateAccountCustomizationRequest.builder()

Parameters:

updateAccountCustomizationRequest - A Consumer that will call methods on UpdateAccountCustomizationRequest.Builder to create a request.

Returns:

Result of the UpdateAccountCustomization operation returned by the service.

See Also:

• AWS API Documentation

updateAccountSettings

default UpdateAccountSettingsResponse updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest)
                                                     throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates the Amazon QuickSight settings in your Amazon Web Services account.

Parameters:

updateAccountSettingsRequest -

Returns:

Result of the UpdateAccountSettings operation returned by the service.

See Also:

• AWS API Documentation

updateAccountSettings

default UpdateAccountSettingsResponse updateAccountSettings(Consumer<UpdateAccountSettingsRequest.Builder> updateAccountSettingsRequest)
                                                     throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates the Amazon QuickSight settings in your Amazon Web Services account.

This is a convenience which creates an instance of the UpdateAccountSettingsRequest.Builder avoiding the need to create one manually via UpdateAccountSettingsRequest.builder()

Parameters:

updateAccountSettingsRequest - A Consumer that will call methods on UpdateAccountSettingsRequest.Builder to create a request.

Returns:

Result of the UpdateAccountSettings operation returned by the service.

See Also:

• AWS API Documentation

updateAnalysis

default UpdateAnalysisResponse updateAnalysis(UpdateAnalysisRequest updateAnalysisRequest)
                                       throws ResourceNotFoundException,
InvalidParameterValueException,
ThrottlingException,
ResourceExistsException,
ConflictException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates an analysis in Amazon QuickSight

Parameters:

updateAnalysisRequest -

Returns:

Result of the UpdateAnalysis operation returned by the service.

See Also:

• AWS API Documentation

updateAnalysis

default UpdateAnalysisResponse updateAnalysis(Consumer<UpdateAnalysisRequest.Builder> updateAnalysisRequest)
                                       throws ResourceNotFoundException,
InvalidParameterValueException,
ThrottlingException,
ResourceExistsException,
ConflictException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates an analysis in Amazon QuickSight

This is a convenience which creates an instance of the UpdateAnalysisRequest.Builder avoiding the need to create one manually via UpdateAnalysisRequest.builder()

Parameters:

updateAnalysisRequest - A Consumer that will call methods on UpdateAnalysisRequest.Builder to create a request.

Returns:

Result of the UpdateAnalysis operation returned by the service.

See Also:

• AWS API Documentation

updateAnalysisPermissions

default UpdateAnalysisPermissionsResponse updateAnalysisPermissions(UpdateAnalysisPermissionsRequest updateAnalysisPermissionsRequest)
                                                             throws ThrottlingException,
InvalidParameterValueException,
ResourceNotFoundException,
UnsupportedUserEditionException,
ConflictException,
LimitExceededException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates the read and write permissions for an analysis.

Parameters:

updateAnalysisPermissionsRequest -

Returns:

Result of the UpdateAnalysisPermissions operation returned by the service.

See Also:

• AWS API Documentation

updateAnalysisPermissions

default UpdateAnalysisPermissionsResponse updateAnalysisPermissions(Consumer<UpdateAnalysisPermissionsRequest.Builder> updateAnalysisPermissionsRequest)
                                                             throws ThrottlingException,
InvalidParameterValueException,
ResourceNotFoundException,
UnsupportedUserEditionException,
ConflictException,
LimitExceededException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates the read and write permissions for an analysis.

This is a convenience which creates an instance of the UpdateAnalysisPermissionsRequest.Builder avoiding the need to create one manually via UpdateAnalysisPermissionsRequest.builder()

Parameters:

updateAnalysisPermissionsRequest - A Consumer that will call methods on UpdateAnalysisPermissionsRequest.Builder to create a request.

Returns:

Result of the UpdateAnalysisPermissions operation returned by the service.

See Also:

• AWS API Documentation

updateDashboard

default UpdateDashboardResponse updateDashboard(UpdateDashboardRequest updateDashboardRequest)
                                         throws ThrottlingException,
InvalidParameterValueException,
ResourceNotFoundException,
ConflictException,
LimitExceededException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates a dashboard in an Amazon Web Services account.

Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation.

Parameters:

updateDashboardRequest -

Returns:

Result of the UpdateDashboard operation returned by the service.

See Also:

• AWS API Documentation

updateDashboard

default UpdateDashboardResponse updateDashboard(Consumer<UpdateDashboardRequest.Builder> updateDashboardRequest)
                                         throws ThrottlingException,
InvalidParameterValueException,
ResourceNotFoundException,
ConflictException,
LimitExceededException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates a dashboard in an Amazon Web Services account.

Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation.

This is a convenience which creates an instance of the UpdateDashboardRequest.Builder avoiding the need to create one manually via UpdateDashboardRequest.builder()

Parameters:

updateDashboardRequest - A Consumer that will call methods on UpdateDashboardRequest.Builder to create a request.

Returns:

Result of the UpdateDashboard operation returned by the service.

See Also:

• AWS API Documentation

updateDashboardPermissions

default UpdateDashboardPermissionsResponse updateDashboardPermissions(UpdateDashboardPermissionsRequest updateDashboardPermissionsRequest)
                                                               throws ThrottlingException,
InvalidParameterValueException,
ResourceNotFoundException,
UnsupportedUserEditionException,
ConflictException,
LimitExceededException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates read and write permissions on a dashboard.

Parameters:

updateDashboardPermissionsRequest -

Returns:

Result of the UpdateDashboardPermissions operation returned by the service.

See Also:

• AWS API Documentation

updateDashboardPermissions

default UpdateDashboardPermissionsResponse updateDashboardPermissions(Consumer<UpdateDashboardPermissionsRequest.Builder> updateDashboardPermissionsRequest)
                                                               throws ThrottlingException,
InvalidParameterValueException,
ResourceNotFoundException,
UnsupportedUserEditionException,
ConflictException,
LimitExceededException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates read and write permissions on a dashboard.

This is a convenience which creates an instance of the UpdateDashboardPermissionsRequest.Builder avoiding the need to create one manually via UpdateDashboardPermissionsRequest.builder()

Parameters:

updateDashboardPermissionsRequest - A Consumer that will call methods on UpdateDashboardPermissionsRequest.Builder to create a request.

Returns:

Result of the UpdateDashboardPermissions operation returned by the service.

See Also:

• AWS API Documentation

updateDashboardPublishedVersion

default UpdateDashboardPublishedVersionResponse updateDashboardPublishedVersion(UpdateDashboardPublishedVersionRequest updateDashboardPublishedVersionRequest)
                                                                         throws InvalidParameterValueException,
ThrottlingException,
ConflictException,
ResourceNotFoundException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates the published version of a dashboard.

Parameters:

updateDashboardPublishedVersionRequest -

Returns:

Result of the UpdateDashboardPublishedVersion operation returned by the service.

See Also:

• AWS API Documentation

updateDashboardPublishedVersion

default UpdateDashboardPublishedVersionResponse updateDashboardPublishedVersion(Consumer<UpdateDashboardPublishedVersionRequest.Builder> updateDashboardPublishedVersionRequest)
                                                                         throws InvalidParameterValueException,
ThrottlingException,
ConflictException,
ResourceNotFoundException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates the published version of a dashboard.

This is a convenience which creates an instance of the UpdateDashboardPublishedVersionRequest.Builder avoiding the need to create one manually via UpdateDashboardPublishedVersionRequest.builder()

Parameters:

updateDashboardPublishedVersionRequest - A Consumer that will call methods on UpdateDashboardPublishedVersionRequest.Builder to create a request.

Returns:

Result of the UpdateDashboardPublishedVersion operation returned by the service.

See Also:

• AWS API Documentation

updateDataSet

default UpdateDataSetResponse updateDataSet(UpdateDataSetRequest updateDataSetRequest)
                                     throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
LimitExceededException,
ThrottlingException,
ResourceNotFoundException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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:

Result of the UpdateDataSet operation returned by the service.

See Also:

• AWS API Documentation

updateDataSet

default UpdateDataSetResponse updateDataSet(Consumer<UpdateDataSetRequest.Builder> updateDataSetRequest)
                                     throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
LimitExceededException,
ThrottlingException,
ResourceNotFoundException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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.Builder avoiding the need to create one manually via UpdateDataSetRequest.builder()

Parameters:

updateDataSetRequest - A Consumer that will call methods on UpdateDataSetRequest.Builder to create a request.

Returns:

Result of the UpdateDataSet operation returned by the service.

See Also:

• AWS API Documentation

updateDataSetPermissions

default UpdateDataSetPermissionsResponse updateDataSetPermissions(UpdateDataSetPermissionsRequest updateDataSetPermissionsRequest)
                                                           throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates the permissions on a dataset.

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

Parameters:

updateDataSetPermissionsRequest -

Returns:

Result of the UpdateDataSetPermissions operation returned by the service.

See Also:

• AWS API Documentation

updateDataSetPermissions

default UpdateDataSetPermissionsResponse updateDataSetPermissions(Consumer<UpdateDataSetPermissionsRequest.Builder> updateDataSetPermissionsRequest)
                                                           throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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.Builder avoiding the need to create one manually via UpdateDataSetPermissionsRequest.builder()

Parameters:

updateDataSetPermissionsRequest - A Consumer that will call methods on UpdateDataSetPermissionsRequest.Builder to create a request.

Returns:

Result of the UpdateDataSetPermissions operation returned by the service.

See Also:

• AWS API Documentation

updateDataSource

default UpdateDataSourceResponse updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)
                                           throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates a data source.

Parameters:

updateDataSourceRequest -

Returns:

Result of the UpdateDataSource operation returned by the service.

See Also:

• AWS API Documentation

updateDataSource

default UpdateDataSourceResponse updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest)
                                           throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates a data source.

This is a convenience which creates an instance of the UpdateDataSourceRequest.Builder avoiding the need to create one manually via UpdateDataSourceRequest.builder()

Parameters:

updateDataSourceRequest - A Consumer that will call methods on UpdateDataSourceRequest.Builder to create a request.

Returns:

Result of the UpdateDataSource operation returned by the service.

See Also:

• AWS API Documentation

updateDataSourcePermissions

default UpdateDataSourcePermissionsResponse updateDataSourcePermissions(UpdateDataSourcePermissionsRequest updateDataSourcePermissionsRequest)
                                                                 throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates the permissions to a data source.

Parameters:

updateDataSourcePermissionsRequest -

Returns:

Result of the UpdateDataSourcePermissions operation returned by the service.

See Also:

• AWS API Documentation

updateDataSourcePermissions

default UpdateDataSourcePermissionsResponse updateDataSourcePermissions(Consumer<UpdateDataSourcePermissionsRequest.Builder> updateDataSourcePermissionsRequest)
                                                                 throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates the permissions to a data source.

This is a convenience which creates an instance of the UpdateDataSourcePermissionsRequest.Builder avoiding the need to create one manually via UpdateDataSourcePermissionsRequest.builder()

Parameters:

updateDataSourcePermissionsRequest - A Consumer that will call methods on UpdateDataSourcePermissionsRequest.Builder to create a request.

Returns:

Result of the UpdateDataSourcePermissions operation returned by the service.

See Also:

• AWS API Documentation

updateFolder

default UpdateFolderResponse updateFolder(UpdateFolderRequest updateFolderRequest)
                                   throws InvalidParameterValueException,
AccessDeniedException,
ResourceExistsException,
ResourceNotFoundException,
ConflictException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates the name of a folder.

Parameters:

updateFolderRequest -

Returns:

Result of the UpdateFolder operation returned by the service.

See Also:

• AWS API Documentation

updateFolder

default UpdateFolderResponse updateFolder(Consumer<UpdateFolderRequest.Builder> updateFolderRequest)
                                   throws InvalidParameterValueException,
AccessDeniedException,
ResourceExistsException,
ResourceNotFoundException,
ConflictException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates the name of a folder.

This is a convenience which creates an instance of the UpdateFolderRequest.Builder avoiding the need to create one manually via UpdateFolderRequest.builder()

Parameters:

updateFolderRequest - A Consumer that will call methods on UpdateFolderRequest.Builder to create a request.

Returns:

Result of the UpdateFolder operation returned by the service.

See Also:

• AWS API Documentation

updateFolderPermissions

default UpdateFolderPermissionsResponse updateFolderPermissions(UpdateFolderPermissionsRequest updateFolderPermissionsRequest)
                                                         throws InvalidParameterValueException,
AccessDeniedException,
LimitExceededException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates permissions of a folder.

Parameters:

updateFolderPermissionsRequest -

Returns:

Result of the UpdateFolderPermissions operation returned by the service.

See Also:

• AWS API Documentation

updateFolderPermissions

default UpdateFolderPermissionsResponse updateFolderPermissions(Consumer<UpdateFolderPermissionsRequest.Builder> updateFolderPermissionsRequest)
                                                         throws InvalidParameterValueException,
AccessDeniedException,
LimitExceededException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates permissions of a folder.

This is a convenience which creates an instance of the UpdateFolderPermissionsRequest.Builder avoiding the need to create one manually via UpdateFolderPermissionsRequest.builder()

Parameters:

updateFolderPermissionsRequest - A Consumer that will call methods on UpdateFolderPermissionsRequest.Builder to create a request.

Returns:

Result of the UpdateFolderPermissions operation returned by the service.

See Also:

• AWS API Documentation

updateGroup

default UpdateGroupResponse updateGroup(UpdateGroupRequest updateGroupRequest)
                                 throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Changes a group description.

Parameters:

updateGroupRequest -

Returns:

Result of the UpdateGroup operation returned by the service.

See Also:

• AWS API Documentation

updateGroup

default UpdateGroupResponse updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)
                                 throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Changes a group description.

This is a convenience which creates an instance of the UpdateGroupRequest.Builder avoiding the need to create one manually via UpdateGroupRequest.builder()

Parameters:

updateGroupRequest - A Consumer that will call methods on UpdateGroupRequest.Builder to create a request.

Returns:

Result of the UpdateGroup operation returned by the service.

See Also:

• AWS API Documentation

updateIAMPolicyAssignment

default UpdateIamPolicyAssignmentResponse updateIAMPolicyAssignment(UpdateIamPolicyAssignmentRequest updateIamPolicyAssignmentRequest)
                                                             throws AccessDeniedException,
InvalidParameterValueException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
ConcurrentUpdatingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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:

Result of the UpdateIAMPolicyAssignment operation returned by the service.

See Also:

• AWS API Documentation

updateIAMPolicyAssignment

default UpdateIamPolicyAssignmentResponse updateIAMPolicyAssignment(Consumer<UpdateIamPolicyAssignmentRequest.Builder> updateIamPolicyAssignmentRequest)
                                                             throws AccessDeniedException,
InvalidParameterValueException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
ConcurrentUpdatingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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.Builder avoiding the need to create one manually via UpdateIamPolicyAssignmentRequest.builder()

Parameters:

updateIamPolicyAssignmentRequest - A Consumer that will call methods on UpdateIamPolicyAssignmentRequest.Builder to create a request.

Returns:

Result of the UpdateIAMPolicyAssignment operation returned by the service.

See Also:

• AWS API Documentation

updateIpRestriction

default UpdateIpRestrictionResponse updateIpRestriction(UpdateIpRestrictionRequest updateIpRestrictionRequest)
                                                 throws LimitExceededException,
AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates the content and status of IP rules. To use this operation, you must provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.

Parameters:

updateIpRestrictionRequest -

Returns:

Result of the UpdateIpRestriction operation returned by the service.

See Also:

• AWS API Documentation

updateIpRestriction

default UpdateIpRestrictionResponse updateIpRestriction(Consumer<UpdateIpRestrictionRequest.Builder> updateIpRestrictionRequest)
                                                 throws LimitExceededException,
AccessDeniedException,
InvalidParameterValueException,
ThrottlingException,
ResourceNotFoundException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates the content and status of IP rules. To use this operation, you must provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.

This is a convenience which creates an instance of the UpdateIpRestrictionRequest.Builder avoiding the need to create one manually via UpdateIpRestrictionRequest.builder()

Parameters:

updateIpRestrictionRequest - A Consumer that will call methods on UpdateIpRestrictionRequest.Builder to create a request.

Returns:

Result of the UpdateIpRestriction operation returned by the service.

See Also:

• AWS API Documentation

updatePublicSharingSettings

default UpdatePublicSharingSettingsResponse updatePublicSharingSettings(UpdatePublicSharingSettingsRequest updatePublicSharingSettingsRequest)
                                                                 throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedPricingPlanException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard.

To use this operation, turn on session capacity pricing for your Amazon QuickSight account.

Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon QuickSight, see Using Amazon QuickSight with IAM in the Amazon QuickSight User Guide.

Parameters:

updatePublicSharingSettingsRequest -

Returns:

Result of the UpdatePublicSharingSettings operation returned by the service.

See Also:

• AWS API Documentation

updatePublicSharingSettings

default UpdatePublicSharingSettingsResponse updatePublicSharingSettings(Consumer<UpdatePublicSharingSettingsRequest.Builder> updatePublicSharingSettingsRequest)
                                                                 throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedPricingPlanException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard.

To use this operation, turn on session capacity pricing for your Amazon QuickSight account.

Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon QuickSight, see Using Amazon QuickSight with IAM in the Amazon QuickSight User Guide.

This is a convenience which creates an instance of the UpdatePublicSharingSettingsRequest.Builder avoiding the need to create one manually via UpdatePublicSharingSettingsRequest.builder()

Parameters:

updatePublicSharingSettingsRequest - A Consumer that will call methods on UpdatePublicSharingSettingsRequest.Builder to create a request.

Returns:

Result of the UpdatePublicSharingSettings operation returned by the service.

See Also:

• AWS API Documentation

updateRefreshSchedule

default UpdateRefreshScheduleResponse updateRefreshSchedule(UpdateRefreshScheduleRequest updateRefreshScheduleRequest)
                                                     throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
PreconditionNotMetException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates a refresh schedule for a dataset.

Parameters:

updateRefreshScheduleRequest -

Returns:

Result of the UpdateRefreshSchedule operation returned by the service.

See Also:

• AWS API Documentation

updateRefreshSchedule

default UpdateRefreshScheduleResponse updateRefreshSchedule(Consumer<UpdateRefreshScheduleRequest.Builder> updateRefreshScheduleRequest)
                                                     throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
LimitExceededException,
PreconditionNotMetException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates a refresh schedule for a dataset.

This is a convenience which creates an instance of the UpdateRefreshScheduleRequest.Builder avoiding the need to create one manually via UpdateRefreshScheduleRequest.builder()

Parameters:

updateRefreshScheduleRequest - A Consumer that will call methods on UpdateRefreshScheduleRequest.Builder to create a request.

Returns:

Result of the UpdateRefreshSchedule operation returned by the service.

See Also:

• AWS API Documentation

updateTemplate

default UpdateTemplateResponse updateTemplate(UpdateTemplateRequest updateTemplateRequest)
                                       throws InvalidParameterValueException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
LimitExceededException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates a template from an existing Amazon QuickSight analysis or another template.

Parameters:

updateTemplateRequest -

Returns:

Result of the UpdateTemplate operation returned by the service.

See Also:

• AWS API Documentation

updateTemplate

default UpdateTemplateResponse updateTemplate(Consumer<UpdateTemplateRequest.Builder> updateTemplateRequest)
                                       throws InvalidParameterValueException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
LimitExceededException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates a template from an existing Amazon QuickSight analysis or another template.

This is a convenience which creates an instance of the UpdateTemplateRequest.Builder avoiding the need to create one manually via UpdateTemplateRequest.builder()

Parameters:

updateTemplateRequest - A Consumer that will call methods on UpdateTemplateRequest.Builder to create a request.

Returns:

Result of the UpdateTemplate operation returned by the service.

See Also:

• AWS API Documentation

updateTemplateAlias

default UpdateTemplateAliasResponse updateTemplateAlias(UpdateTemplateAliasRequest updateTemplateAliasRequest)
                                                 throws ThrottlingException,
ResourceNotFoundException,
ConflictException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates the template alias of a template.

Parameters:

updateTemplateAliasRequest -

Returns:

Result of the UpdateTemplateAlias operation returned by the service.

See Also:

• AWS API Documentation

updateTemplateAlias

default UpdateTemplateAliasResponse updateTemplateAlias(Consumer<UpdateTemplateAliasRequest.Builder> updateTemplateAliasRequest)
                                                 throws ThrottlingException,
ResourceNotFoundException,
ConflictException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates the template alias of a template.

This is a convenience which creates an instance of the UpdateTemplateAliasRequest.Builder avoiding the need to create one manually via UpdateTemplateAliasRequest.builder()

Parameters:

updateTemplateAliasRequest - A Consumer that will call methods on UpdateTemplateAliasRequest.Builder to create a request.

Returns:

Result of the UpdateTemplateAlias operation returned by the service.

See Also:

• AWS API Documentation

updateTemplatePermissions

default UpdateTemplatePermissionsResponse updateTemplatePermissions(UpdateTemplatePermissionsRequest updateTemplatePermissionsRequest)
                                                             throws ThrottlingException,
InvalidParameterValueException,
ConflictException,
ResourceNotFoundException,
UnsupportedUserEditionException,
LimitExceededException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates the resource permissions for a template.

Parameters:

updateTemplatePermissionsRequest -

Returns:

Result of the UpdateTemplatePermissions operation returned by the service.

See Also:

• AWS API Documentation

updateTemplatePermissions

default UpdateTemplatePermissionsResponse updateTemplatePermissions(Consumer<UpdateTemplatePermissionsRequest.Builder> updateTemplatePermissionsRequest)
                                                             throws ThrottlingException,
InvalidParameterValueException,
ConflictException,
ResourceNotFoundException,
UnsupportedUserEditionException,
LimitExceededException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates the resource permissions for a template.

This is a convenience which creates an instance of the UpdateTemplatePermissionsRequest.Builder avoiding the need to create one manually via UpdateTemplatePermissionsRequest.builder()

Parameters:

updateTemplatePermissionsRequest - A Consumer that will call methods on UpdateTemplatePermissionsRequest.Builder to create a request.

Returns:

Result of the UpdateTemplatePermissions operation returned by the service.

See Also:

• AWS API Documentation

updateTheme

default UpdateThemeResponse updateTheme(UpdateThemeRequest updateThemeRequest)
                                 throws AccessDeniedException,
InvalidParameterValueException,
LimitExceededException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates a theme.

Parameters:

updateThemeRequest -

Returns:

Result of the UpdateTheme operation returned by the service.

See Also:

• AWS API Documentation

updateTheme

default UpdateThemeResponse updateTheme(Consumer<UpdateThemeRequest.Builder> updateThemeRequest)
                                 throws AccessDeniedException,
InvalidParameterValueException,
LimitExceededException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates a theme.

This is a convenience which creates an instance of the UpdateThemeRequest.Builder avoiding the need to create one manually via UpdateThemeRequest.builder()

Parameters:

updateThemeRequest - A Consumer that will call methods on UpdateThemeRequest.Builder to create a request.

Returns:

Result of the UpdateTheme operation returned by the service.

See Also:

• AWS API Documentation

updateThemeAlias

default UpdateThemeAliasResponse updateThemeAlias(UpdateThemeAliasRequest updateThemeAliasRequest)
                                           throws ConflictException,
InvalidParameterValueException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates an alias of a theme.

Parameters:

updateThemeAliasRequest -

Returns:

Result of the UpdateThemeAlias operation returned by the service.

See Also:

• AWS API Documentation

updateThemeAlias

default UpdateThemeAliasResponse updateThemeAlias(Consumer<UpdateThemeAliasRequest.Builder> updateThemeAliasRequest)
                                           throws ConflictException,
InvalidParameterValueException,
ResourceExistsException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates an alias of a theme.

This is a convenience which creates an instance of the UpdateThemeAliasRequest.Builder avoiding the need to create one manually via UpdateThemeAliasRequest.builder()

Parameters:

updateThemeAliasRequest - A Consumer that will call methods on UpdateThemeAliasRequest.Builder to create a request.

Returns:

Result of the UpdateThemeAlias operation returned by the service.

See Also:

• AWS API Documentation

updateThemePermissions

default UpdateThemePermissionsResponse updateThemePermissions(UpdateThemePermissionsRequest updateThemePermissionsRequest)
                                                       throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
LimitExceededException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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:

Result of the UpdateThemePermissions operation returned by the service.

See Also:

• AWS API Documentation

updateThemePermissions

default UpdateThemePermissionsResponse updateThemePermissions(Consumer<UpdateThemePermissionsRequest.Builder> updateThemePermissionsRequest)
                                                       throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
LimitExceededException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

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.Builder avoiding the need to create one manually via UpdateThemePermissionsRequest.builder()

Parameters:

updateThemePermissionsRequest - A Consumer that will call methods on UpdateThemePermissionsRequest.Builder to create a request.

Returns:

Result of the UpdateThemePermissions operation returned by the service.

See Also:

• AWS API Documentation

updateTopic

default UpdateTopicResponse updateTopic(UpdateTopicRequest updateTopicRequest)
                                 throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
LimitExceededException,
ResourceNotFoundException,
ResourceExistsException,
ThrottlingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates a topic.

Parameters:

updateTopicRequest -

Returns:

Result of the UpdateTopic operation returned by the service.

See Also:

• AWS API Documentation

updateTopic

default UpdateTopicResponse updateTopic(Consumer<UpdateTopicRequest.Builder> updateTopicRequest)
                                 throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
LimitExceededException,
ResourceNotFoundException,
ResourceExistsException,
ThrottlingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates a topic.

This is a convenience which creates an instance of the UpdateTopicRequest.Builder avoiding the need to create one manually via UpdateTopicRequest.builder()

Parameters:

updateTopicRequest - A Consumer that will call methods on UpdateTopicRequest.Builder to create a request.

Returns:

Result of the UpdateTopic operation returned by the service.

See Also:

• AWS API Documentation

updateTopicPermissions

default UpdateTopicPermissionsResponse updateTopicPermissions(UpdateTopicPermissionsRequest updateTopicPermissionsRequest)
                                                       throws AccessDeniedException,
ThrottlingException,
InvalidParameterValueException,
ResourceNotFoundException,
UnsupportedUserEditionException,
ConflictException,
LimitExceededException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates the permissions of a topic.

Parameters:

updateTopicPermissionsRequest -

Returns:

Result of the UpdateTopicPermissions operation returned by the service.

See Also:

• AWS API Documentation

updateTopicPermissions

default UpdateTopicPermissionsResponse updateTopicPermissions(Consumer<UpdateTopicPermissionsRequest.Builder> updateTopicPermissionsRequest)
                                                       throws AccessDeniedException,
ThrottlingException,
InvalidParameterValueException,
ResourceNotFoundException,
UnsupportedUserEditionException,
ConflictException,
LimitExceededException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates the permissions of a topic.

This is a convenience which creates an instance of the UpdateTopicPermissionsRequest.Builder avoiding the need to create one manually via UpdateTopicPermissionsRequest.builder()

Parameters:

updateTopicPermissionsRequest - A Consumer that will call methods on UpdateTopicPermissionsRequest.Builder to create a request.

Returns:

Result of the UpdateTopicPermissions operation returned by the service.

See Also:

• AWS API Documentation

updateTopicRefreshSchedule

default UpdateTopicRefreshScheduleResponse updateTopicRefreshSchedule(UpdateTopicRefreshScheduleRequest updateTopicRefreshScheduleRequest)
                                                               throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
LimitExceededException,
ResourceNotFoundException,
ResourceExistsException,
ThrottlingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates a topic refresh schedule.

Parameters:

updateTopicRefreshScheduleRequest -

Returns:

Result of the UpdateTopicRefreshSchedule operation returned by the service.

See Also:

• AWS API Documentation

updateTopicRefreshSchedule

default UpdateTopicRefreshScheduleResponse updateTopicRefreshSchedule(Consumer<UpdateTopicRefreshScheduleRequest.Builder> updateTopicRefreshScheduleRequest)
                                                               throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
LimitExceededException,
ResourceNotFoundException,
ResourceExistsException,
ThrottlingException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates a topic refresh schedule.

This is a convenience which creates an instance of the UpdateTopicRefreshScheduleRequest.Builder avoiding the need to create one manually via UpdateTopicRefreshScheduleRequest.builder()

Parameters:

updateTopicRefreshScheduleRequest - A Consumer that will call methods on UpdateTopicRefreshScheduleRequest.Builder to create a request.

Returns:

Result of the UpdateTopicRefreshSchedule operation returned by the service.

See Also:

• AWS API Documentation

updateUser

default UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest)
                               throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates an Amazon QuickSight user.

Parameters:

updateUserRequest -

Returns:

Result of the UpdateUser operation returned by the service.

See Also:

• AWS API Documentation

updateUser

default UpdateUserResponse updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)
                               throws AccessDeniedException,
InvalidParameterValueException,
ResourceNotFoundException,
ThrottlingException,
PreconditionNotMetException,
InternalFailureException,
ResourceUnavailableException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates an Amazon QuickSight user.

This is a convenience which creates an instance of the UpdateUserRequest.Builder avoiding the need to create one manually via UpdateUserRequest.builder()

Parameters:

updateUserRequest - A Consumer that will call methods on UpdateUserRequest.Builder to create a request.

Returns:

Result of the UpdateUser operation returned by the service.

See Also:

• AWS API Documentation

updateVPCConnection

default UpdateVpcConnectionResponse updateVPCConnection(UpdateVpcConnectionRequest updateVpcConnectionRequest)
                                                 throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
LimitExceededException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates a VPC connection.

Parameters:

updateVpcConnectionRequest -

Returns:

Result of the UpdateVPCConnection operation returned by the service.

See Also:

• AWS API Documentation

updateVPCConnection

default UpdateVpcConnectionResponse updateVPCConnection(Consumer<UpdateVpcConnectionRequest.Builder> updateVpcConnectionRequest)
                                                 throws AccessDeniedException,
ConflictException,
InvalidParameterValueException,
LimitExceededException,
ResourceNotFoundException,
ThrottlingException,
UnsupportedUserEditionException,
InternalFailureException,
AwsServiceException,
SdkClientException,
QuickSightException

Updates a VPC connection.

This is a convenience which creates an instance of the UpdateVpcConnectionRequest.Builder avoiding the need to create one manually via UpdateVpcConnectionRequest.builder()

Parameters:

updateVpcConnectionRequest - A Consumer that will call methods on UpdateVpcConnectionRequest.Builder to create a request.

Returns:

Result of the UpdateVPCConnection operation returned by the service.

See Also:

• AWS API Documentation

create

static QuickSightClient create()

Create a QuickSightClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static QuickSightClientBuilder builder()

Create a builder that can be used to configure and create a QuickSightClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default QuickSightServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration