Interface QuickSightClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbatchCreateTopicReviewedAnswer
(Consumer<BatchCreateTopicReviewedAnswerRequest.Builder> batchCreateTopicReviewedAnswerRequest) Creates new reviewed answers for a Q Topic.batchCreateTopicReviewedAnswer
(BatchCreateTopicReviewedAnswerRequest batchCreateTopicReviewedAnswerRequest) Creates new reviewed answers for a Q Topic.batchDeleteTopicReviewedAnswer
(Consumer<BatchDeleteTopicReviewedAnswerRequest.Builder> batchDeleteTopicReviewedAnswerRequest) Deletes reviewed answers for Q Topic.batchDeleteTopicReviewedAnswer
(BatchDeleteTopicReviewedAnswerRequest batchDeleteTopicReviewedAnswerRequest) Deletes reviewed answers for Q Topic.static QuickSightClientBuilder
builder()
Create a builder that can be used to configure and create aQuickSightClient
.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 aQuickSightClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createAccountCustomization
(Consumer<CreateAccountCustomizationRequest.Builder> createAccountCustomizationRequest) Creates Amazon QuickSight customizations for the current Amazon Web Services Region.createAccountCustomization
(CreateAccountCustomizationRequest createAccountCustomizationRequest) Creates Amazon QuickSight customizations for the current Amazon Web Services Region.createAccountSubscription
(Consumer<CreateAccountSubscriptionRequest.Builder> createAccountSubscriptionRequest) Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.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 aDashboardDefinition
.default CreateDashboardResponse
createDashboard
(CreateDashboardRequest createDashboardRequest) Creates a dashboard from either a template or directly with aDashboardDefinition
.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 theCreateGroup
operation to create a group in Amazon QuickSight.default CreateGroupResponse
createGroup
(CreateGroupRequest createGroupRequest) Use theCreateGroup
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.createIAMPolicyAssignment
(Consumer<CreateIamPolicyAssignmentRequest.Builder> createIamPolicyAssignmentRequest) Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN).createIAMPolicyAssignment
(CreateIamPolicyAssignmentRequest createIamPolicyAssignmentRequest) Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN).default 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 CreateRoleMembershipResponse
createRoleMembership
(Consumer<CreateRoleMembershipRequest.Builder> createRoleMembershipRequest) UseCreateRoleMembership
to add an existing Amazon QuickSight group to an existing role.default CreateRoleMembershipResponse
createRoleMembership
(CreateRoleMembershipRequest createRoleMembershipRequest) UseCreateRoleMembership
to add an existing Amazon QuickSight group to an existing role.default CreateTemplateResponse
createTemplate
(Consumer<CreateTemplateRequest.Builder> createTemplateRequest) Creates a template either from aTemplateDefinition
or from an existing Amazon QuickSight analysis or template.default CreateTemplateResponse
createTemplate
(CreateTemplateRequest createTemplateRequest) Creates a template either from aTemplateDefinition
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.createTopicRefreshSchedule
(Consumer<CreateTopicRefreshScheduleRequest.Builder> createTopicRefreshScheduleRequest) Creates a topic refresh schedule.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.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.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.deleteAccountSubscription
(Consumer<DeleteAccountSubscriptionRequest.Builder> deleteAccountSubscriptionRequest) Use theDeleteAccountSubscription
operation to delete an Amazon QuickSight account.deleteAccountSubscription
(DeleteAccountSubscriptionRequest deleteAccountSubscriptionRequest) Use theDeleteAccountSubscription
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.deleteDataSetRefreshProperties
(Consumer<DeleteDataSetRefreshPropertiesRequest.Builder> deleteDataSetRefreshPropertiesRequest) Deletes the dataset refresh properties of the dataset.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.deleteIAMPolicyAssignment
(Consumer<DeleteIamPolicyAssignmentRequest.Builder> deleteIamPolicyAssignmentRequest) Deletes an existing IAM policy assignment.deleteIAMPolicyAssignment
(DeleteIamPolicyAssignmentRequest deleteIamPolicyAssignmentRequest) Deletes an existing IAM policy assignment.deleteIdentityPropagationConfig
(Consumer<DeleteIdentityPropagationConfigRequest.Builder> deleteIdentityPropagationConfigRequest) Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application.deleteIdentityPropagationConfig
(DeleteIdentityPropagationConfigRequest deleteIdentityPropagationConfigRequest) Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application.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.deleteRoleCustomPermission
(Consumer<DeleteRoleCustomPermissionRequest.Builder> deleteRoleCustomPermissionRequest) Removes custom permissions from the role.deleteRoleCustomPermission
(DeleteRoleCustomPermissionRequest deleteRoleCustomPermissionRequest) Removes custom permissions from the role.default DeleteRoleMembershipResponse
deleteRoleMembership
(Consumer<DeleteRoleMembershipRequest.Builder> deleteRoleMembershipRequest) Removes a group from a role.default DeleteRoleMembershipResponse
deleteRoleMembership
(DeleteRoleMembershipRequest deleteRoleMembershipRequest) Removes a group from a role.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.deleteTopicRefreshSchedule
(Consumer<DeleteTopicRefreshScheduleRequest.Builder> deleteTopicRefreshScheduleRequest) Deletes a topic refresh schedule.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.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.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.describeAccountSubscription
(Consumer<DescribeAccountSubscriptionRequest.Builder> describeAccountSubscriptionRequest) Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription.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.describeAnalysisDefinition
(Consumer<DescribeAnalysisDefinitionRequest.Builder> describeAnalysisDefinitionRequest) Provides a detailed description of the definition of an analysis.describeAnalysisDefinition
(DescribeAnalysisDefinitionRequest describeAnalysisDefinitionRequest) Provides a detailed description of the definition of an analysis.describeAnalysisPermissions
(Consumer<DescribeAnalysisPermissionsRequest.Builder> describeAnalysisPermissionsRequest) Provides the read and write permissions for an analysis.describeAnalysisPermissions
(DescribeAnalysisPermissionsRequest describeAnalysisPermissionsRequest) Provides the read and write permissions for an analysis.describeAssetBundleExportJob
(Consumer<DescribeAssetBundleExportJobRequest.Builder> describeAssetBundleExportJobRequest) Describes an existing export job.describeAssetBundleExportJob
(DescribeAssetBundleExportJobRequest describeAssetBundleExportJobRequest) Describes an existing export job.describeAssetBundleImportJob
(Consumer<DescribeAssetBundleImportJobRequest.Builder> describeAssetBundleImportJobRequest) Describes an existing import job.describeAssetBundleImportJob
(DescribeAssetBundleImportJobRequest describeAssetBundleImportJobRequest) Describes an existing import job.default DescribeDashboardResponse
describeDashboard
(Consumer<DescribeDashboardRequest.Builder> describeDashboardRequest) Provides a summary for a dashboard.default DescribeDashboardResponse
describeDashboard
(DescribeDashboardRequest describeDashboardRequest) Provides a summary for a dashboard.describeDashboardDefinition
(Consumer<DescribeDashboardDefinitionRequest.Builder> describeDashboardDefinitionRequest) Provides a detailed description of the definition of a dashboard.describeDashboardDefinition
(DescribeDashboardDefinitionRequest describeDashboardDefinitionRequest) Provides a detailed description of the definition of a dashboard.describeDashboardPermissions
(Consumer<DescribeDashboardPermissionsRequest.Builder> describeDashboardPermissionsRequest) Describes read and write permissions for a dashboard.describeDashboardPermissions
(DescribeDashboardPermissionsRequest describeDashboardPermissionsRequest) Describes read and write permissions for a dashboard.describeDashboardSnapshotJob
(Consumer<DescribeDashboardSnapshotJobRequest.Builder> describeDashboardSnapshotJobRequest) Describes an existing snapshot job.describeDashboardSnapshotJob
(DescribeDashboardSnapshotJobRequest describeDashboardSnapshotJobRequest) Describes an existing snapshot job.describeDashboardSnapshotJobResult
(Consumer<DescribeDashboardSnapshotJobResultRequest.Builder> describeDashboardSnapshotJobResultRequest) Describes the result of an existing snapshot job that has finished running.describeDashboardSnapshotJobResult
(DescribeDashboardSnapshotJobResultRequest describeDashboardSnapshotJobResultRequest) Describes the result of an existing snapshot job that has finished running.default DescribeDataSetResponse
describeDataSet
(Consumer<DescribeDataSetRequest.Builder> describeDataSetRequest) Describes a dataset.default DescribeDataSetResponse
describeDataSet
(DescribeDataSetRequest describeDataSetRequest) Describes a dataset.describeDataSetPermissions
(Consumer<DescribeDataSetPermissionsRequest.Builder> describeDataSetPermissionsRequest) Describes the permissions on a dataset.describeDataSetPermissions
(DescribeDataSetPermissionsRequest describeDataSetPermissionsRequest) Describes the permissions on a dataset.describeDataSetRefreshProperties
(Consumer<DescribeDataSetRefreshPropertiesRequest.Builder> describeDataSetRefreshPropertiesRequest) Describes the refresh properties of a dataset.describeDataSetRefreshProperties
(DescribeDataSetRefreshPropertiesRequest describeDataSetRefreshPropertiesRequest) Describes the refresh properties of a dataset.default DescribeDataSourceResponse
describeDataSource
(Consumer<DescribeDataSourceRequest.Builder> describeDataSourceRequest) Describes a data source.default DescribeDataSourceResponse
describeDataSource
(DescribeDataSourceRequest describeDataSourceRequest) Describes a data source.describeDataSourcePermissions
(Consumer<DescribeDataSourcePermissionsRequest.Builder> describeDataSourcePermissionsRequest) Describes the resource permissions for a data source.describeDataSourcePermissions
(DescribeDataSourcePermissionsRequest describeDataSourcePermissionsRequest) Describes the resource permissions for a data source.default DescribeFolderResponse
describeFolder
(Consumer<DescribeFolderRequest.Builder> describeFolderRequest) Describes a folder.default DescribeFolderResponse
describeFolder
(DescribeFolderRequest describeFolderRequest) Describes a folder.describeFolderPermissions
(Consumer<DescribeFolderPermissionsRequest.Builder> describeFolderPermissionsRequest) Describes permissions for a folder.describeFolderPermissions
(DescribeFolderPermissionsRequest describeFolderPermissionsRequest) Describes permissions for a folder.describeFolderPermissionsPaginator
(Consumer<DescribeFolderPermissionsRequest.Builder> describeFolderPermissionsRequest) This is a variant ofdescribeFolderPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsRequest)
operation.describeFolderPermissionsPaginator
(DescribeFolderPermissionsRequest describeFolderPermissionsRequest) This is a variant ofdescribeFolderPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsRequest)
operation.describeFolderResolvedPermissions
(Consumer<DescribeFolderResolvedPermissionsRequest.Builder> describeFolderResolvedPermissionsRequest) Describes the folder resolved permissions.describeFolderResolvedPermissions
(DescribeFolderResolvedPermissionsRequest describeFolderResolvedPermissionsRequest) Describes the folder resolved permissions.describeFolderResolvedPermissionsPaginator
(Consumer<DescribeFolderResolvedPermissionsRequest.Builder> describeFolderResolvedPermissionsRequest) This is a variant ofdescribeFolderResolvedPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsRequest)
operation.describeFolderResolvedPermissionsPaginator
(DescribeFolderResolvedPermissionsRequest describeFolderResolvedPermissionsRequest) This is a variant ofdescribeFolderResolvedPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsRequest)
operation.default 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 theDescribeGroupMembership
operation to determine if a user is a member of the specified group.default DescribeGroupMembershipResponse
describeGroupMembership
(DescribeGroupMembershipRequest describeGroupMembershipRequest) Use theDescribeGroupMembership
operation to determine if a user is a member of the specified group.describeIAMPolicyAssignment
(Consumer<DescribeIamPolicyAssignmentRequest.Builder> describeIamPolicyAssignmentRequest) Describes an existing IAM policy assignment, as specified by the assignment name.describeIAMPolicyAssignment
(DescribeIamPolicyAssignmentRequest describeIamPolicyAssignmentRequest) Describes an existing IAM policy assignment, as specified by the assignment name.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 DescribeKeyRegistrationResponse
describeKeyRegistration
(Consumer<DescribeKeyRegistrationRequest.Builder> describeKeyRegistrationRequest) Describes all customer managed key registrations in a Amazon QuickSight account.default DescribeKeyRegistrationResponse
describeKeyRegistration
(DescribeKeyRegistrationRequest describeKeyRegistrationRequest) Describes all customer managed key registrations in a Amazon QuickSight account.default DescribeNamespaceResponse
describeNamespace
(Consumer<DescribeNamespaceRequest.Builder> describeNamespaceRequest) Describes the current namespace.default DescribeNamespaceResponse
describeNamespace
(DescribeNamespaceRequest describeNamespaceRequest) Describes the current namespace.describeQPersonalizationConfiguration
(Consumer<DescribeQPersonalizationConfigurationRequest.Builder> describeQPersonalizationConfigurationRequest) Describes a personalization configuration.describeQPersonalizationConfiguration
(DescribeQPersonalizationConfigurationRequest describeQPersonalizationConfigurationRequest) Describes a personalization configuration.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.describeRoleCustomPermission
(Consumer<DescribeRoleCustomPermissionRequest.Builder> describeRoleCustomPermissionRequest) Describes all custom permissions that are mapped to a role.describeRoleCustomPermission
(DescribeRoleCustomPermissionRequest describeRoleCustomPermissionRequest) Describes all custom permissions that are mapped to a role.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.describeTemplateDefinition
(Consumer<DescribeTemplateDefinitionRequest.Builder> describeTemplateDefinitionRequest) Provides a detailed description of the definition of a template.describeTemplateDefinition
(DescribeTemplateDefinitionRequest describeTemplateDefinitionRequest) Provides a detailed description of the definition of a template.describeTemplatePermissions
(Consumer<DescribeTemplatePermissionsRequest.Builder> describeTemplatePermissionsRequest) Describes read and write permissions on a template.describeTemplatePermissions
(DescribeTemplatePermissionsRequest describeTemplatePermissionsRequest) Describes read and write permissions on a template.default 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.describeTopicRefreshSchedule
(Consumer<DescribeTopicRefreshScheduleRequest.Builder> describeTopicRefreshScheduleRequest) Deletes a topic refresh schedule.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.generateEmbedUrlForAnonymousUser
(Consumer<GenerateEmbedUrlForAnonymousUserRequest.Builder> generateEmbedUrlForAnonymousUserRequest) Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users.generateEmbedUrlForAnonymousUser
(GenerateEmbedUrlForAnonymousUserRequest generateEmbedUrlForAnonymousUserRequest) Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users.generateEmbedUrlForRegisteredUser
(Consumer<GenerateEmbedUrlForRegisteredUserRequest.Builder> generateEmbedUrlForRegisteredUserRequest) Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website.generateEmbedUrlForRegisteredUser
(GenerateEmbedUrlForRegisteredUserRequest generateEmbedUrlForRegisteredUserRequest) Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website.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) This is a variant oflistAnalyses(software.amazon.awssdk.services.quicksight.model.ListAnalysesRequest)
operation.default ListAnalysesIterable
listAnalysesPaginator
(ListAnalysesRequest listAnalysesRequest) This is a variant oflistAnalyses(software.amazon.awssdk.services.quicksight.model.ListAnalysesRequest)
operation.listAssetBundleExportJobs
(Consumer<ListAssetBundleExportJobsRequest.Builder> listAssetBundleExportJobsRequest) Lists all asset bundle export jobs that have been taken place in the last 14 days.listAssetBundleExportJobs
(ListAssetBundleExportJobsRequest listAssetBundleExportJobsRequest) Lists all asset bundle export jobs that have been taken place in the last 14 days.listAssetBundleExportJobsPaginator
(Consumer<ListAssetBundleExportJobsRequest.Builder> listAssetBundleExportJobsRequest) This is a variant oflistAssetBundleExportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsRequest)
operation.listAssetBundleExportJobsPaginator
(ListAssetBundleExportJobsRequest listAssetBundleExportJobsRequest) This is a variant oflistAssetBundleExportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsRequest)
operation.listAssetBundleImportJobs
(Consumer<ListAssetBundleImportJobsRequest.Builder> listAssetBundleImportJobsRequest) Lists all asset bundle import jobs that have taken place in the last 14 days.listAssetBundleImportJobs
(ListAssetBundleImportJobsRequest listAssetBundleImportJobsRequest) Lists all asset bundle import jobs that have taken place in the last 14 days.listAssetBundleImportJobsPaginator
(Consumer<ListAssetBundleImportJobsRequest.Builder> listAssetBundleImportJobsRequest) This is a variant oflistAssetBundleImportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsRequest)
operation.listAssetBundleImportJobsPaginator
(ListAssetBundleImportJobsRequest listAssetBundleImportJobsRequest) This is a variant oflistAssetBundleImportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsRequest)
operation.default 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) This is a variant oflistDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest)
operation.default ListDashboardsIterable
listDashboardsPaginator
(ListDashboardsRequest listDashboardsRequest) This is a variant oflistDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest)
operation.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) This is a variant oflistDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest)
operation.default ListDashboardVersionsIterable
listDashboardVersionsPaginator
(ListDashboardVersionsRequest listDashboardVersionsRequest) This is a variant oflistDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest)
operation.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) This is a variant oflistDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest)
operation.default ListDataSetsIterable
listDataSetsPaginator
(ListDataSetsRequest listDataSetsRequest) This is a variant oflistDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest)
operation.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) This is a variant oflistDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest)
operation.default ListDataSourcesIterable
listDataSourcesPaginator
(ListDataSourcesRequest listDataSourcesRequest) This is a variant oflistDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest)
operation.default ListFolderMembersResponse
listFolderMembers
(Consumer<ListFolderMembersRequest.Builder> listFolderMembersRequest) List all assets (DASHBOARD
,ANALYSIS
, andDATASET
) in a folder.default ListFolderMembersResponse
listFolderMembers
(ListFolderMembersRequest listFolderMembersRequest) List all assets (DASHBOARD
,ANALYSIS
, andDATASET
) in a folder.default ListFolderMembersIterable
listFolderMembersPaginator
(Consumer<ListFolderMembersRequest.Builder> listFolderMembersRequest) This is a variant oflistFolderMembers(software.amazon.awssdk.services.quicksight.model.ListFolderMembersRequest)
operation.default ListFolderMembersIterable
listFolderMembersPaginator
(ListFolderMembersRequest listFolderMembersRequest) This is a variant oflistFolderMembers(software.amazon.awssdk.services.quicksight.model.ListFolderMembersRequest)
operation.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 ListFoldersForResourceResponse
listFoldersForResource
(Consumer<ListFoldersForResourceRequest.Builder> listFoldersForResourceRequest) List all folders that a resource is a member of.default ListFoldersForResourceResponse
listFoldersForResource
(ListFoldersForResourceRequest listFoldersForResourceRequest) List all folders that a resource is a member of.default ListFoldersForResourceIterable
listFoldersForResourcePaginator
(Consumer<ListFoldersForResourceRequest.Builder> listFoldersForResourceRequest) This is a variant oflistFoldersForResource(software.amazon.awssdk.services.quicksight.model.ListFoldersForResourceRequest)
operation.default ListFoldersForResourceIterable
listFoldersForResourcePaginator
(ListFoldersForResourceRequest listFoldersForResourceRequest) This is a variant oflistFoldersForResource(software.amazon.awssdk.services.quicksight.model.ListFoldersForResourceRequest)
operation.default ListFoldersIterable
listFoldersPaginator
(Consumer<ListFoldersRequest.Builder> listFoldersRequest) This is a variant oflistFolders(software.amazon.awssdk.services.quicksight.model.ListFoldersRequest)
operation.default ListFoldersIterable
listFoldersPaginator
(ListFoldersRequest listFoldersRequest) This is a variant oflistFolders(software.amazon.awssdk.services.quicksight.model.ListFoldersRequest)
operation.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) This is a variant oflistGroupMemberships(software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsRequest)
operation.default ListGroupMembershipsIterable
listGroupMembershipsPaginator
(ListGroupMembershipsRequest listGroupMembershipsRequest) This is a variant oflistGroupMemberships(software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsRequest)
operation.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) This is a variant oflistGroups(software.amazon.awssdk.services.quicksight.model.ListGroupsRequest)
operation.default ListGroupsIterable
listGroupsPaginator
(ListGroupsRequest listGroupsRequest) This is a variant oflistGroups(software.amazon.awssdk.services.quicksight.model.ListGroupsRequest)
operation.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.listIAMPolicyAssignmentsForUser
(Consumer<ListIamPolicyAssignmentsForUserRequest.Builder> listIamPolicyAssignmentsForUserRequest) Lists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to.listIAMPolicyAssignmentsForUser
(ListIamPolicyAssignmentsForUserRequest listIamPolicyAssignmentsForUserRequest) Lists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to.listIAMPolicyAssignmentsForUserPaginator
(Consumer<ListIamPolicyAssignmentsForUserRequest.Builder> listIamPolicyAssignmentsForUserRequest) This is a variant oflistIAMPolicyAssignmentsForUser(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserRequest)
operation.listIAMPolicyAssignmentsForUserPaginator
(ListIamPolicyAssignmentsForUserRequest listIamPolicyAssignmentsForUserRequest) This is a variant oflistIAMPolicyAssignmentsForUser(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserRequest)
operation.default ListIAMPolicyAssignmentsIterable
listIAMPolicyAssignmentsPaginator
(Consumer<ListIamPolicyAssignmentsRequest.Builder> listIamPolicyAssignmentsRequest) This is a variant oflistIAMPolicyAssignments(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsRequest)
operation.default ListIAMPolicyAssignmentsIterable
listIAMPolicyAssignmentsPaginator
(ListIamPolicyAssignmentsRequest listIamPolicyAssignmentsRequest) This is a variant oflistIAMPolicyAssignments(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsRequest)
operation.listIdentityPropagationConfigs
(Consumer<ListIdentityPropagationConfigsRequest.Builder> listIdentityPropagationConfigsRequest) Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access.listIdentityPropagationConfigs
(ListIdentityPropagationConfigsRequest listIdentityPropagationConfigsRequest) Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access.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) This is a variant oflistIngestions(software.amazon.awssdk.services.quicksight.model.ListIngestionsRequest)
operation.default ListIngestionsIterable
listIngestionsPaginator
(ListIngestionsRequest listIngestionsRequest) This is a variant oflistIngestions(software.amazon.awssdk.services.quicksight.model.ListIngestionsRequest)
operation.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) This is a variant oflistNamespaces(software.amazon.awssdk.services.quicksight.model.ListNamespacesRequest)
operation.default ListNamespacesIterable
listNamespacesPaginator
(ListNamespacesRequest listNamespacesRequest) This is a variant oflistNamespaces(software.amazon.awssdk.services.quicksight.model.ListNamespacesRequest)
operation.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 ListRoleMembershipsResponse
listRoleMemberships
(Consumer<ListRoleMembershipsRequest.Builder> listRoleMembershipsRequest) Lists all groups that are associated with a role.default ListRoleMembershipsResponse
listRoleMemberships
(ListRoleMembershipsRequest listRoleMembershipsRequest) Lists all groups that are associated with a role.default ListRoleMembershipsIterable
listRoleMembershipsPaginator
(Consumer<ListRoleMembershipsRequest.Builder> listRoleMembershipsRequest) This is a variant oflistRoleMemberships(software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsRequest)
operation.default ListRoleMembershipsIterable
listRoleMembershipsPaginator
(ListRoleMembershipsRequest listRoleMembershipsRequest) This is a variant oflistRoleMemberships(software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsRequest)
operation.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) This is a variant oflistTemplateAliases(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesRequest)
operation.default ListTemplateAliasesIterable
listTemplateAliasesPaginator
(ListTemplateAliasesRequest listTemplateAliasesRequest) This is a variant oflistTemplateAliases(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesRequest)
operation.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) This is a variant oflistTemplates(software.amazon.awssdk.services.quicksight.model.ListTemplatesRequest)
operation.default ListTemplatesIterable
listTemplatesPaginator
(ListTemplatesRequest listTemplatesRequest) This is a variant oflistTemplates(software.amazon.awssdk.services.quicksight.model.ListTemplatesRequest)
operation.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) This is a variant oflistTemplateVersions(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsRequest)
operation.default ListTemplateVersionsIterable
listTemplateVersionsPaginator
(ListTemplateVersionsRequest listTemplateVersionsRequest) This is a variant oflistTemplateVersions(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsRequest)
operation.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) This is a variant oflistThemes(software.amazon.awssdk.services.quicksight.model.ListThemesRequest)
operation.default ListThemesIterable
listThemesPaginator
(ListThemesRequest listThemesRequest) This is a variant oflistThemes(software.amazon.awssdk.services.quicksight.model.ListThemesRequest)
operation.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) This is a variant oflistThemeVersions(software.amazon.awssdk.services.quicksight.model.ListThemeVersionsRequest)
operation.default ListThemeVersionsIterable
listThemeVersionsPaginator
(ListThemeVersionsRequest listThemeVersionsRequest) This is a variant oflistThemeVersions(software.amazon.awssdk.services.quicksight.model.ListThemeVersionsRequest)
operation.listTopicRefreshSchedules
(Consumer<ListTopicRefreshSchedulesRequest.Builder> listTopicRefreshSchedulesRequest) Lists all of the refresh schedules for a topic.listTopicRefreshSchedules
(ListTopicRefreshSchedulesRequest listTopicRefreshSchedulesRequest) Lists all of the refresh schedules for a topic.default ListTopicReviewedAnswersResponse
listTopicReviewedAnswers
(Consumer<ListTopicReviewedAnswersRequest.Builder> listTopicReviewedAnswersRequest) Lists all reviewed answers for a Q Topic.default ListTopicReviewedAnswersResponse
listTopicReviewedAnswers
(ListTopicReviewedAnswersRequest listTopicReviewedAnswersRequest) Lists all reviewed answers for a Q 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) This is a variant oflistTopics(software.amazon.awssdk.services.quicksight.model.ListTopicsRequest)
operation.default ListTopicsIterable
listTopicsPaginator
(ListTopicsRequest listTopicsRequest) This is a variant oflistTopics(software.amazon.awssdk.services.quicksight.model.ListTopicsRequest)
operation.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) This is a variant oflistUserGroups(software.amazon.awssdk.services.quicksight.model.ListUserGroupsRequest)
operation.default ListUserGroupsIterable
listUserGroupsPaginator
(ListUserGroupsRequest listUserGroupsRequest) This is a variant oflistUserGroups(software.amazon.awssdk.services.quicksight.model.ListUserGroupsRequest)
operation.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) This is a variant oflistUsers(software.amazon.awssdk.services.quicksight.model.ListUsersRequest)
operation.default ListUsersIterable
listUsersPaginator
(ListUsersRequest listUsersRequest) This is a variant oflistUsers(software.amazon.awssdk.services.quicksight.model.ListUsersRequest)
operation.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) This is a variant oflistVPCConnections(software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsRequest)
operation.default ListVPCConnectionsIterable
listVPCConnectionsPaginator
(ListVpcConnectionsRequest listVpcConnectionsRequest) This is a variant oflistVPCConnections(software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsRequest)
operation.putDataSetRefreshProperties
(Consumer<PutDataSetRefreshPropertiesRequest.Builder> putDataSetRefreshPropertiesRequest) Creates or updates the dataset refresh properties for the dataset.putDataSetRefreshProperties
(PutDataSetRefreshPropertiesRequest putDataSetRefreshPropertiesRequest) Creates or updates the dataset refresh properties for the dataset.default 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) This is a variant ofsearchAnalyses(software.amazon.awssdk.services.quicksight.model.SearchAnalysesRequest)
operation.default SearchAnalysesIterable
searchAnalysesPaginator
(SearchAnalysesRequest searchAnalysesRequest) This is a variant ofsearchAnalyses(software.amazon.awssdk.services.quicksight.model.SearchAnalysesRequest)
operation.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) This is a variant ofsearchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest)
operation.default SearchDashboardsIterable
searchDashboardsPaginator
(SearchDashboardsRequest searchDashboardsRequest) This is a variant ofsearchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest)
operation.default SearchDataSetsResponse
searchDataSets
(Consumer<SearchDataSetsRequest.Builder> searchDataSetsRequest) Use theSearchDataSets
operation to search for datasets that belong to an account.default SearchDataSetsResponse
searchDataSets
(SearchDataSetsRequest searchDataSetsRequest) Use theSearchDataSets
operation to search for datasets that belong to an account.default SearchDataSetsIterable
searchDataSetsPaginator
(Consumer<SearchDataSetsRequest.Builder> searchDataSetsRequest) This is a variant ofsearchDataSets(software.amazon.awssdk.services.quicksight.model.SearchDataSetsRequest)
operation.default SearchDataSetsIterable
searchDataSetsPaginator
(SearchDataSetsRequest searchDataSetsRequest) This is a variant ofsearchDataSets(software.amazon.awssdk.services.quicksight.model.SearchDataSetsRequest)
operation.default SearchDataSourcesResponse
searchDataSources
(Consumer<SearchDataSourcesRequest.Builder> searchDataSourcesRequest) Use theSearchDataSources
operation to search for data sources that belong to an account.default SearchDataSourcesResponse
searchDataSources
(SearchDataSourcesRequest searchDataSourcesRequest) Use theSearchDataSources
operation to search for data sources that belong to an account.default SearchDataSourcesIterable
searchDataSourcesPaginator
(Consumer<SearchDataSourcesRequest.Builder> searchDataSourcesRequest) This is a variant ofsearchDataSources(software.amazon.awssdk.services.quicksight.model.SearchDataSourcesRequest)
operation.default SearchDataSourcesIterable
searchDataSourcesPaginator
(SearchDataSourcesRequest searchDataSourcesRequest) This is a variant ofsearchDataSources(software.amazon.awssdk.services.quicksight.model.SearchDataSourcesRequest)
operation.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) This is a variant ofsearchFolders(software.amazon.awssdk.services.quicksight.model.SearchFoldersRequest)
operation.default SearchFoldersIterable
searchFoldersPaginator
(SearchFoldersRequest searchFoldersRequest) This is a variant ofsearchFolders(software.amazon.awssdk.services.quicksight.model.SearchFoldersRequest)
operation.default SearchGroupsResponse
searchGroups
(Consumer<SearchGroupsRequest.Builder> searchGroupsRequest) Use theSearchGroups
operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.default SearchGroupsResponse
searchGroups
(SearchGroupsRequest searchGroupsRequest) Use theSearchGroups
operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.default SearchGroupsIterable
searchGroupsPaginator
(Consumer<SearchGroupsRequest.Builder> searchGroupsRequest) This is a variant ofsearchGroups(software.amazon.awssdk.services.quicksight.model.SearchGroupsRequest)
operation.default SearchGroupsIterable
searchGroupsPaginator
(SearchGroupsRequest searchGroupsRequest) This is a variant ofsearchGroups(software.amazon.awssdk.services.quicksight.model.SearchGroupsRequest)
operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
startAssetBundleExportJob
(Consumer<StartAssetBundleExportJobRequest.Builder> startAssetBundleExportJobRequest) Starts an Asset Bundle export job.startAssetBundleExportJob
(StartAssetBundleExportJobRequest startAssetBundleExportJobRequest) Starts an Asset Bundle export job.startAssetBundleImportJob
(Consumer<StartAssetBundleImportJobRequest.Builder> startAssetBundleImportJobRequest) Starts an Asset Bundle import job.startAssetBundleImportJob
(StartAssetBundleImportJobRequest startAssetBundleImportJobRequest) Starts an Asset Bundle import job.startDashboardSnapshotJob
(Consumer<StartDashboardSnapshotJobRequest.Builder> startDashboardSnapshotJobRequest) Starts an asynchronous job that generates a snapshot of a dashboard's output.startDashboardSnapshotJob
(StartDashboardSnapshotJobRequest startDashboardSnapshotJobRequest) Starts an asynchronous job that generates a snapshot of a dashboard's output.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.updateAccountCustomization
(Consumer<UpdateAccountCustomizationRequest.Builder> updateAccountCustomizationRequest) Updates Amazon QuickSight customizations for the current Amazon Web Services Region.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 QuickSightdefault UpdateAnalysisResponse
updateAnalysis
(UpdateAnalysisRequest updateAnalysisRequest) Updates an analysis in Amazon QuickSightupdateAnalysisPermissions
(Consumer<UpdateAnalysisPermissionsRequest.Builder> updateAnalysisPermissionsRequest) Updates the read and write permissions for an analysis.updateAnalysisPermissions
(UpdateAnalysisPermissionsRequest updateAnalysisPermissionsRequest) Updates the read and write permissions for an analysis.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 UpdateDashboardLinksResponse
updateDashboardLinks
(Consumer<UpdateDashboardLinksRequest.Builder> updateDashboardLinksRequest) Updates the linked analyses on a dashboard.default UpdateDashboardLinksResponse
updateDashboardLinks
(UpdateDashboardLinksRequest updateDashboardLinksRequest) Updates the linked analyses on a dashboard.updateDashboardPermissions
(Consumer<UpdateDashboardPermissionsRequest.Builder> updateDashboardPermissionsRequest) Updates read and write permissions on a dashboard.updateDashboardPermissions
(UpdateDashboardPermissionsRequest updateDashboardPermissionsRequest) Updates read and write permissions on a dashboard.updateDashboardPublishedVersion
(Consumer<UpdateDashboardPublishedVersionRequest.Builder> updateDashboardPublishedVersionRequest) Updates the published version of a dashboard.updateDashboardPublishedVersion
(UpdateDashboardPublishedVersionRequest updateDashboardPublishedVersionRequest) Updates the published version of a dashboard.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.updateDataSourcePermissions
(Consumer<UpdateDataSourcePermissionsRequest.Builder> updateDataSourcePermissionsRequest) Updates the permissions to a data source.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.updateIAMPolicyAssignment
(Consumer<UpdateIamPolicyAssignmentRequest.Builder> updateIamPolicyAssignmentRequest) Updates an existing IAM policy assignment.updateIAMPolicyAssignment
(UpdateIamPolicyAssignmentRequest updateIamPolicyAssignmentRequest) Updates an existing IAM policy assignment.updateIdentityPropagationConfig
(Consumer<UpdateIdentityPropagationConfigRequest.Builder> updateIdentityPropagationConfigRequest) Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access.updateIdentityPropagationConfig
(UpdateIdentityPropagationConfigRequest updateIdentityPropagationConfigRequest) Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access.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 UpdateKeyRegistrationResponse
updateKeyRegistration
(Consumer<UpdateKeyRegistrationRequest.Builder> updateKeyRegistrationRequest) Updates a customer managed key in a Amazon QuickSight account.default UpdateKeyRegistrationResponse
updateKeyRegistration
(UpdateKeyRegistrationRequest updateKeyRegistrationRequest) Updates a customer managed key in a Amazon QuickSight account.updatePublicSharingSettings
(Consumer<UpdatePublicSharingSettingsRequest.Builder> updatePublicSharingSettingsRequest) Use theUpdatePublicSharingSettings
operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard.updatePublicSharingSettings
(UpdatePublicSharingSettingsRequest updatePublicSharingSettingsRequest) Use theUpdatePublicSharingSettings
operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard.updateQPersonalizationConfiguration
(Consumer<UpdateQPersonalizationConfigurationRequest.Builder> updateQPersonalizationConfigurationRequest) Updates a personalization configuration.updateQPersonalizationConfiguration
(UpdateQPersonalizationConfigurationRequest updateQPersonalizationConfigurationRequest) Updates a personalization configuration.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.updateRoleCustomPermission
(Consumer<UpdateRoleCustomPermissionRequest.Builder> updateRoleCustomPermissionRequest) Updates the custom permissions that are associated with a role.updateRoleCustomPermission
(UpdateRoleCustomPermissionRequest updateRoleCustomPermissionRequest) Updates the custom permissions that are associated with a role.updateSPICECapacityConfiguration
(Consumer<UpdateSpiceCapacityConfigurationRequest.Builder> updateSpiceCapacityConfigurationRequest) Updates the SPICE capacity configuration for a Amazon QuickSight account.updateSPICECapacityConfiguration
(UpdateSpiceCapacityConfigurationRequest updateSpiceCapacityConfigurationRequest) Updates the SPICE capacity configuration for a Amazon QuickSight account.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.updateTemplatePermissions
(Consumer<UpdateTemplatePermissionsRequest.Builder> updateTemplatePermissionsRequest) Updates the resource permissions for a template.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.updateTopicRefreshSchedule
(Consumer<UpdateTopicRefreshScheduleRequest.Builder> updateTopicRefreshScheduleRequest) Updates a topic refresh schedule.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
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
batchCreateTopicReviewedAnswer
default BatchCreateTopicReviewedAnswerResponse batchCreateTopicReviewedAnswer(BatchCreateTopicReviewedAnswerRequest batchCreateTopicReviewedAnswerRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException Creates new reviewed answers for a Q Topic.
- Parameters:
batchCreateTopicReviewedAnswerRequest
-- Returns:
- Result of the BatchCreateTopicReviewedAnswer operation returned by the service.
- See Also:
-
batchCreateTopicReviewedAnswer
default BatchCreateTopicReviewedAnswerResponse batchCreateTopicReviewedAnswer(Consumer<BatchCreateTopicReviewedAnswerRequest.Builder> batchCreateTopicReviewedAnswerRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException Creates new reviewed answers for a Q Topic.
This is a convenience which creates an instance of the
BatchCreateTopicReviewedAnswerRequest.Builder
avoiding the need to create one manually viaBatchCreateTopicReviewedAnswerRequest.builder()
- Parameters:
batchCreateTopicReviewedAnswerRequest
- AConsumer
that will call methods onBatchCreateTopicReviewedAnswerRequest.Builder
to create a request.- Returns:
- Result of the BatchCreateTopicReviewedAnswer operation returned by the service.
- See Also:
-
batchDeleteTopicReviewedAnswer
default BatchDeleteTopicReviewedAnswerResponse batchDeleteTopicReviewedAnswer(BatchDeleteTopicReviewedAnswerRequest batchDeleteTopicReviewedAnswerRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, ConflictException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException Deletes reviewed answers for Q Topic.
- Parameters:
batchDeleteTopicReviewedAnswerRequest
-- Returns:
- Result of the BatchDeleteTopicReviewedAnswer operation returned by the service.
- See Also:
-
batchDeleteTopicReviewedAnswer
default BatchDeleteTopicReviewedAnswerResponse batchDeleteTopicReviewedAnswer(Consumer<BatchDeleteTopicReviewedAnswerRequest.Builder> batchDeleteTopicReviewedAnswerRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, ConflictException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException Deletes reviewed answers for Q Topic.
This is a convenience which creates an instance of the
BatchDeleteTopicReviewedAnswerRequest.Builder
avoiding the need to create one manually viaBatchDeleteTopicReviewedAnswerRequest.builder()
- Parameters:
batchDeleteTopicReviewedAnswerRequest
- AConsumer
that will call methods onBatchDeleteTopicReviewedAnswerRequest.Builder
to create a request.- Returns:
- Result of the BatchDeleteTopicReviewedAnswer operation returned by the service.
- See Also:
-
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:
-
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 viaCancelIngestionRequest.builder()
- Parameters:
cancelIngestionRequest
- AConsumer
that will call methods onCancelIngestionRequest.Builder
to create a request.- Returns:
- Result of the CancelIngestion operation returned by the service.
- See Also:
-
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
orUpdateAccountCustomization
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 theDescribeThemePermissions
API operation. To share the theme, grant permissions by using theUpdateThemePermissions
API operation.- Parameters:
createAccountCustomizationRequest
-- Returns:
- Result of the CreateAccountCustomization operation returned by the service.
- See Also:
-
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
orUpdateAccountCustomization
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 theDescribeThemePermissions
API operation. To share the theme, grant permissions by using theUpdateThemePermissions
API operation.
This is a convenience which creates an instance of the
CreateAccountCustomizationRequest.Builder
avoiding the need to create one manually viaCreateAccountCustomizationRequest.builder()
- Parameters:
createAccountCustomizationRequest
- AConsumer
that will call methods onCreateAccountCustomizationRequest.Builder
to create a request.- Returns:
- Result of the CreateAccountCustomization operation returned by the service.
- See Also:
-
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.
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
andCreateAccountSubscription
actions, make sure that both actions are set toAllow
. If either action is set toDeny
, theDeny
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:
-
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.
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
andCreateAccountSubscription
actions, make sure that both actions are set toAllow
. If either action is set toDeny
, theDeny
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 viaCreateAccountSubscriptionRequest.builder()
- Parameters:
createAccountSubscriptionRequest
- AConsumer
that will call methods onCreateAccountSubscriptionRequest.Builder
to create a request.- Returns:
- Result of the CreateAccountSubscription operation returned by the service.
- See Also:
-
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:
-
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 viaCreateAnalysisRequest.builder()
- Parameters:
createAnalysisRequest
- AConsumer
that will call methods onCreateAnalysisRequest.Builder
to create a request.- Returns:
- Result of the CreateAnalysis operation returned by the service.
- See Also:
-
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 theCreateTemplate
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:
-
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 theCreateTemplate
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 viaCreateDashboardRequest.builder()
- Parameters:
createDashboardRequest
- AConsumer
that will call methods onCreateDashboardRequest.Builder
to create a request.- Returns:
- Result of the CreateDashboard operation returned by the service.
- See Also:
-
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:
-
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 viaCreateDataSetRequest.builder()
- Parameters:
createDataSetRequest
- AConsumer
that will call methods onCreateDataSetRequest.Builder
to create a request.- Returns:
- Result of the CreateDataSet operation returned by the service.
- See Also:
-
createDataSource
default CreateDataSourceResponse createDataSource(CreateDataSourceRequest createDataSourceRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceNotFoundException, ResourceExistsException, ThrottlingException, CustomerManagedKeyUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException Creates a data source.
- Parameters:
createDataSourceRequest
-- Returns:
- Result of the CreateDataSource operation returned by the service.
- See Also:
-
createDataSource
default CreateDataSourceResponse createDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceNotFoundException, ResourceExistsException, ThrottlingException, CustomerManagedKeyUnavailableException, 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 viaCreateDataSourceRequest.builder()
- Parameters:
createDataSourceRequest
- AConsumer
that will call methods onCreateDataSourceRequest.Builder
to create a request.- Returns:
- Result of the CreateDataSource operation returned by the service.
- See Also:
-
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:
-
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 viaCreateFolderRequest.builder()
- Parameters:
createFolderRequest
- AConsumer
that will call methods onCreateFolderRequest.Builder
to create a request.- Returns:
- Result of the CreateFolder operation returned by the service.
- See Also:
-
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:
-
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 viaCreateFolderMembershipRequest.builder()
- Parameters:
createFolderMembershipRequest
- AConsumer
that will call methods onCreateFolderMembershipRequest.Builder
to create a request.- Returns:
- Result of the CreateFolderMembership operation returned by the service.
- See Also:
-
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 Amazon Web Services Support.The permissions resource is
arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name>
.The response is a group object.
- Parameters:
createGroupRequest
- The request object for this operation.- Returns:
- Result of the CreateGroup operation returned by the service.
- See Also:
-
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 Amazon Web Services Support.The permissions resource is
arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name>
.The response is a group object.
This is a convenience which creates an instance of the
CreateGroupRequest.Builder
avoiding the need to create one manually viaCreateGroupRequest.builder()
- Parameters:
createGroupRequest
- AConsumer
that will call methods onCreateGroupRequest.Builder
to create a request. The request object for this operation.- Returns:
- Result of the CreateGroup operation returned by the service.
- See Also:
-
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:
-
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 viaCreateGroupMembershipRequest.builder()
- Parameters:
createGroupMembershipRequest
- AConsumer
that will call methods onCreateGroupMembershipRequest.Builder
to create a request.- Returns:
- Result of the CreateGroupMembership operation returned by the service.
- See Also:
-
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:
-
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 viaCreateIamPolicyAssignmentRequest.builder()
- Parameters:
createIamPolicyAssignmentRequest
- AConsumer
that will call methods onCreateIamPolicyAssignmentRequest.Builder
to create a request.- Returns:
- Result of the CreateIAMPolicyAssignment operation returned by the service.
- See Also:
-
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:
-
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 viaCreateIngestionRequest.builder()
- Parameters:
createIngestionRequest
- AConsumer
that will call methods onCreateIngestionRequest.Builder
to create a request.- Returns:
- Result of the CreateIngestion operation returned by the service.
- See Also:
-
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:
-
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 viaCreateNamespaceRequest.builder()
- Parameters:
createNamespaceRequest
- AConsumer
that will call methods onCreateNamespaceRequest.Builder
to create a request.- Returns:
- Result of the CreateNamespace operation returned by the service.
- See Also:
-
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:
-
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 viaCreateRefreshScheduleRequest.builder()
- Parameters:
createRefreshScheduleRequest
- AConsumer
that will call methods onCreateRefreshScheduleRequest.Builder
to create a request.- Returns:
- Result of the CreateRefreshSchedule operation returned by the service.
- See Also:
-
createRoleMembership
default CreateRoleMembershipResponse createRoleMembership(CreateRoleMembershipRequest createRoleMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException Use
CreateRoleMembership
to add an existing Amazon QuickSight group to an existing role.- Parameters:
createRoleMembershipRequest
-- Returns:
- Result of the CreateRoleMembership operation returned by the service.
- See Also:
-
createRoleMembership
default CreateRoleMembershipResponse createRoleMembership(Consumer<CreateRoleMembershipRequest.Builder> createRoleMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException Use
CreateRoleMembership
to add an existing Amazon QuickSight group to an existing role.
This is a convenience which creates an instance of the
CreateRoleMembershipRequest.Builder
avoiding the need to create one manually viaCreateRoleMembershipRequest.builder()
- Parameters:
createRoleMembershipRequest
- AConsumer
that will call methods onCreateRoleMembershipRequest.Builder
to create a request.- Returns:
- Result of the CreateRoleMembership operation returned by the service.
- See Also:
-
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:
-
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 viaCreateTemplateRequest.builder()
- Parameters:
createTemplateRequest
- AConsumer
that will call methods onCreateTemplateRequest.Builder
to create a request.- Returns:
- Result of the CreateTemplate operation returned by the service.
- See Also:
-
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:
-
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 viaCreateTemplateAliasRequest.builder()
- Parameters:
createTemplateAliasRequest
- AConsumer
that will call methods onCreateTemplateAliasRequest.Builder
to create a request.- Returns:
- Result of the CreateTemplateAlias operation returned by the service.
- See Also:
-
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:
-
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 viaCreateThemeRequest.builder()
- Parameters:
createThemeRequest
- AConsumer
that will call methods onCreateThemeRequest.Builder
to create a request.- Returns:
- Result of the CreateTheme operation returned by the service.
- See Also:
-
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:
-
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 viaCreateThemeAliasRequest.builder()
- Parameters:
createThemeAliasRequest
- AConsumer
that will call methods onCreateThemeAliasRequest.Builder
to create a request.- Returns:
- Result of the CreateThemeAlias operation returned by the service.
- See Also:
-
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:
-
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 viaCreateTopicRequest.builder()
- Parameters:
createTopicRequest
- AConsumer
that will call methods onCreateTopicRequest.Builder
to create a request.- Returns:
- Result of the CreateTopic operation returned by the service.
- See Also:
-
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:
-
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 viaCreateTopicRefreshScheduleRequest.builder()
- Parameters:
createTopicRefreshScheduleRequest
- AConsumer
that will call methods onCreateTopicRefreshScheduleRequest.Builder
to create a request.- Returns:
- Result of the CreateTopicRefreshSchedule operation returned by the service.
- See Also:
-
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:
-
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 viaCreateVpcConnectionRequest.builder()
- Parameters:
createVpcConnectionRequest
- AConsumer
that will call methods onCreateVpcConnectionRequest.Builder
to create a request.- Returns:
- Result of the CreateVPCConnection operation returned by the service.
- See Also:
-
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:
-
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 viaDeleteAccountCustomizationRequest.builder()
- Parameters:
deleteAccountCustomizationRequest
- AConsumer
that will call methods onDeleteAccountCustomizationRequest.Builder
to create a request.- Returns:
- Result of the DeleteAccountCustomization operation returned by the service.
- See Also:
-
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 toTrue
. To change this setting and delete your account, call theUpdateAccountSettings
API and set the value of theTerminationProtectionEnabled
parameter toFalse
, then make another call to theDeleteAccountSubscription
API.- Parameters:
deleteAccountSubscriptionRequest
-- Returns:
- Result of the DeleteAccountSubscription operation returned by the service.
- See Also:
-
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 toTrue
. To change this setting and delete your account, call theUpdateAccountSettings
API and set the value of theTerminationProtectionEnabled
parameter toFalse
, then make another call to theDeleteAccountSubscription
API.
This is a convenience which creates an instance of the
DeleteAccountSubscriptionRequest.Builder
avoiding the need to create one manually viaDeleteAccountSubscriptionRequest.builder()
- Parameters:
deleteAccountSubscriptionRequest
- AConsumer
that will call methods onDeleteAccountSubscriptionRequest.Builder
to create a request.- Returns:
- Result of the DeleteAccountSubscription operation returned by the service.
- See Also:
-
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 theDeletionTime
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:
-
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 theDeletionTime
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 viaDeleteAnalysisRequest.builder()
- Parameters:
deleteAnalysisRequest
- AConsumer
that will call methods onDeleteAnalysisRequest.Builder
to create a request.- Returns:
- Result of the DeleteAnalysis operation returned by the service.
- See Also:
-
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:
-
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 viaDeleteDashboardRequest.builder()
- Parameters:
deleteDashboardRequest
- AConsumer
that will call methods onDeleteDashboardRequest.Builder
to create a request.- Returns:
- Result of the DeleteDashboard operation returned by the service.
- See Also:
-
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:
-
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 viaDeleteDataSetRequest.builder()
- Parameters:
deleteDataSetRequest
- AConsumer
that will call methods onDeleteDataSetRequest.Builder
to create a request.- Returns:
- Result of the DeleteDataSet operation returned by the service.
- See Also:
-
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:
-
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 viaDeleteDataSetRefreshPropertiesRequest.builder()
- Parameters:
deleteDataSetRefreshPropertiesRequest
- AConsumer
that will call methods onDeleteDataSetRefreshPropertiesRequest.Builder
to create a request.- Returns:
- Result of the DeleteDataSetRefreshProperties operation returned by the service.
- See Also:
-
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:
-
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 viaDeleteDataSourceRequest.builder()
- Parameters:
deleteDataSourceRequest
- AConsumer
that will call methods onDeleteDataSourceRequest.Builder
to create a request.- Returns:
- Result of the DeleteDataSource operation returned by the service.
- See Also:
-
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:
-
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 viaDeleteFolderRequest.builder()
- Parameters:
deleteFolderRequest
- AConsumer
that will call methods onDeleteFolderRequest.Builder
to create a request.- Returns:
- Result of the DeleteFolder operation returned by the service.
- See Also:
-
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:
-
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 viaDeleteFolderMembershipRequest.builder()
- Parameters:
deleteFolderMembershipRequest
- AConsumer
that will call methods onDeleteFolderMembershipRequest.Builder
to create a request.- Returns:
- Result of the DeleteFolderMembership operation returned by the service.
- See Also:
-
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:
-
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 viaDeleteGroupRequest.builder()
- Parameters:
deleteGroupRequest
- AConsumer
that will call methods onDeleteGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteGroup operation returned by the service.
- See Also:
-
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:
-
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 viaDeleteGroupMembershipRequest.builder()
- Parameters:
deleteGroupMembershipRequest
- AConsumer
that will call methods onDeleteGroupMembershipRequest.Builder
to create a request.- Returns:
- Result of the DeleteGroupMembership operation returned by the service.
- See Also:
-
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:
-
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 viaDeleteIamPolicyAssignmentRequest.builder()
- Parameters:
deleteIamPolicyAssignmentRequest
- AConsumer
that will call methods onDeleteIamPolicyAssignmentRequest.Builder
to create a request.- Returns:
- Result of the DeleteIAMPolicyAssignment operation returned by the service.
- See Also:
-
deleteIdentityPropagationConfig
default DeleteIdentityPropagationConfigResponse deleteIdentityPropagationConfig(DeleteIdentityPropagationConfigRequest deleteIdentityPropagationConfigRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application.
This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.
- Parameters:
deleteIdentityPropagationConfigRequest
-- Returns:
- Result of the DeleteIdentityPropagationConfig operation returned by the service.
- See Also:
-
deleteIdentityPropagationConfig
default DeleteIdentityPropagationConfigResponse deleteIdentityPropagationConfig(Consumer<DeleteIdentityPropagationConfigRequest.Builder> deleteIdentityPropagationConfigRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application.
This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.
This is a convenience which creates an instance of the
DeleteIdentityPropagationConfigRequest.Builder
avoiding the need to create one manually viaDeleteIdentityPropagationConfigRequest.builder()
- Parameters:
deleteIdentityPropagationConfigRequest
- AConsumer
that will call methods onDeleteIdentityPropagationConfigRequest.Builder
to create a request.- Returns:
- Result of the DeleteIdentityPropagationConfig operation returned by the service.
- See Also:
-
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:
-
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 viaDeleteNamespaceRequest.builder()
- Parameters:
deleteNamespaceRequest
- AConsumer
that will call methods onDeleteNamespaceRequest.Builder
to create a request.- Returns:
- Result of the DeleteNamespace operation returned by the service.
- See Also:
-
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:
-
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 viaDeleteRefreshScheduleRequest.builder()
- Parameters:
deleteRefreshScheduleRequest
- AConsumer
that will call methods onDeleteRefreshScheduleRequest.Builder
to create a request.- Returns:
- Result of the DeleteRefreshSchedule operation returned by the service.
- See Also:
-
deleteRoleCustomPermission
default DeleteRoleCustomPermissionResponse deleteRoleCustomPermission(DeleteRoleCustomPermissionRequest deleteRoleCustomPermissionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException Removes custom permissions from the role.
- Parameters:
deleteRoleCustomPermissionRequest
-- Returns:
- Result of the DeleteRoleCustomPermission operation returned by the service.
- See Also:
-
deleteRoleCustomPermission
default DeleteRoleCustomPermissionResponse deleteRoleCustomPermission(Consumer<DeleteRoleCustomPermissionRequest.Builder> deleteRoleCustomPermissionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException Removes custom permissions from the role.
This is a convenience which creates an instance of the
DeleteRoleCustomPermissionRequest.Builder
avoiding the need to create one manually viaDeleteRoleCustomPermissionRequest.builder()
- Parameters:
deleteRoleCustomPermissionRequest
- AConsumer
that will call methods onDeleteRoleCustomPermissionRequest.Builder
to create a request.- Returns:
- Result of the DeleteRoleCustomPermission operation returned by the service.
- See Also:
-
deleteRoleMembership
default DeleteRoleMembershipResponse deleteRoleMembership(DeleteRoleMembershipRequest deleteRoleMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException Removes a group from a role.
- Parameters:
deleteRoleMembershipRequest
-- Returns:
- Result of the DeleteRoleMembership operation returned by the service.
- See Also:
-
deleteRoleMembership
default DeleteRoleMembershipResponse deleteRoleMembership(Consumer<DeleteRoleMembershipRequest.Builder> deleteRoleMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException Removes a group from a role.
This is a convenience which creates an instance of the
DeleteRoleMembershipRequest.Builder
avoiding the need to create one manually viaDeleteRoleMembershipRequest.builder()
- Parameters:
deleteRoleMembershipRequest
- AConsumer
that will call methods onDeleteRoleMembershipRequest.Builder
to create a request.- Returns:
- Result of the DeleteRoleMembership operation returned by the service.
- See Also:
-
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:
-
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 viaDeleteTemplateRequest.builder()
- Parameters:
deleteTemplateRequest
- AConsumer
that will call methods onDeleteTemplateRequest.Builder
to create a request.- Returns:
- Result of the DeleteTemplate operation returned by the service.
- See Also:
-
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:
-
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 viaDeleteTemplateAliasRequest.builder()
- Parameters:
deleteTemplateAliasRequest
- AConsumer
that will call methods onDeleteTemplateAliasRequest.Builder
to create a request.- Returns:
- Result of the DeleteTemplateAlias operation returned by the service.
- See Also:
-
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:
-
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 viaDeleteThemeRequest.builder()
- Parameters:
deleteThemeRequest
- AConsumer
that will call methods onDeleteThemeRequest.Builder
to create a request.- Returns:
- Result of the DeleteTheme operation returned by the service.
- See Also:
-
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:
-
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 viaDeleteThemeAliasRequest.builder()
- Parameters:
deleteThemeAliasRequest
- AConsumer
that will call methods onDeleteThemeAliasRequest.Builder
to create a request.- Returns:
- Result of the DeleteThemeAlias operation returned by the service.
- See Also:
-
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:
-
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 viaDeleteTopicRequest.builder()
- Parameters:
deleteTopicRequest
- AConsumer
that will call methods onDeleteTopicRequest.Builder
to create a request.- Returns:
- Result of the DeleteTopic operation returned by the service.
- See Also:
-
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:
-
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 viaDeleteTopicRefreshScheduleRequest.builder()
- Parameters:
deleteTopicRefreshScheduleRequest
- AConsumer
that will call methods onDeleteTopicRefreshScheduleRequest.Builder
to create a request.- Returns:
- Result of the DeleteTopicRefreshSchedule operation returned by the service.
- See Also:
-
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:
-
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 viaDeleteUserRequest.builder()
- Parameters:
deleteUserRequest
- AConsumer
that will call methods onDeleteUserRequest.Builder
to create a request.- Returns:
- Result of the DeleteUser operation returned by the service.
- See Also:
-
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:
-
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 viaDeleteUserByPrincipalIdRequest.builder()
- Parameters:
deleteUserByPrincipalIdRequest
- AConsumer
that will call methods onDeleteUserByPrincipalIdRequest.Builder
to create a request.- Returns:
- Result of the DeleteUserByPrincipalId operation returned by the service.
- See Also:
-
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:
-
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 viaDeleteVpcConnectionRequest.builder()
- Parameters:
deleteVpcConnectionRequest
- AConsumer
that will call methods onDeleteVpcConnectionRequest.Builder
to create a request.- Returns:
- Result of the DeleteVPCConnection operation returned by the service.
- See Also:
-
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 theCreateAccountCustomization
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:
-
-
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 theCreateAccountCustomization
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 viaDescribeAccountCustomizationRequest.builder()
- Parameters:
describeAccountCustomizationRequest
- AConsumer
that will call methods onDescribeAccountCustomizationRequest.Builder
to create a request.- Returns:
- Result of the DescribeAccountCustomization operation returned by the service.
- See Also:
-
-
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:
-
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 viaDescribeAccountSettingsRequest.builder()
- Parameters:
describeAccountSettingsRequest
- AConsumer
that will call methods onDescribeAccountSettingsRequest.Builder
to create a request.- Returns:
- Result of the DescribeAccountSettings operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeAccountSubscriptionRequest.builder()
- Parameters:
describeAccountSubscriptionRequest
- AConsumer
that will call methods onDescribeAccountSubscriptionRequest.Builder
to create a request.- Returns:
- Result of the DescribeAccountSubscription operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeAnalysisRequest.builder()
- Parameters:
describeAnalysisRequest
- AConsumer
that will call methods onDescribeAnalysisRequest.Builder
to create a request.- Returns:
- Result of the DescribeAnalysis operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeAnalysisDefinitionRequest.builder()
- Parameters:
describeAnalysisDefinitionRequest
- AConsumer
that will call methods onDescribeAnalysisDefinitionRequest.Builder
to create a request.- Returns:
- Result of the DescribeAnalysisDefinition operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeAnalysisPermissionsRequest.builder()
- Parameters:
describeAnalysisPermissionsRequest
- AConsumer
that will call methods onDescribeAnalysisPermissionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeAnalysisPermissions operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeAssetBundleExportJobRequest.builder()
- Parameters:
describeAssetBundleExportJobRequest
- AConsumer
that will call methods onDescribeAssetBundleExportJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeAssetBundleExportJob operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeAssetBundleImportJobRequest.builder()
- Parameters:
describeAssetBundleImportJobRequest
- AConsumer
that will call methods onDescribeAssetBundleImportJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeAssetBundleImportJob operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeDashboardRequest.builder()
- Parameters:
describeDashboardRequest
- AConsumer
that will call methods onDescribeDashboardRequest.Builder
to create a request.- Returns:
- Result of the DescribeDashboard operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeDashboardDefinitionRequest.builder()
- Parameters:
describeDashboardDefinitionRequest
- AConsumer
that will call methods onDescribeDashboardDefinitionRequest.Builder
to create a request.- Returns:
- Result of the DescribeDashboardDefinition operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeDashboardPermissionsRequest.builder()
- Parameters:
describeDashboardPermissionsRequest
- AConsumer
that will call methods onDescribeDashboardPermissionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeDashboardPermissions operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeDashboardSnapshotJobRequest.builder()
- Parameters:
describeDashboardSnapshotJobRequest
- AConsumer
that will call methods onDescribeDashboardSnapshotJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeDashboardSnapshotJob operation returned by the service.
- See Also:
-
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
orFAILED
status when you poll the job with aDescribeDashboardSnapshotJob
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:
-
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
orFAILED
status when you poll the job with aDescribeDashboardSnapshotJob
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 viaDescribeDashboardSnapshotJobResultRequest.builder()
- Parameters:
describeDashboardSnapshotJobResultRequest
- AConsumer
that will call methods onDescribeDashboardSnapshotJobResultRequest.Builder
to create a request.- Returns:
- Result of the DescribeDashboardSnapshotJobResult operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeDataSetRequest.builder()
- Parameters:
describeDataSetRequest
- AConsumer
that will call methods onDescribeDataSetRequest.Builder
to create a request.- Returns:
- Result of the DescribeDataSet operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeDataSetPermissionsRequest.builder()
- Parameters:
describeDataSetPermissionsRequest
- AConsumer
that will call methods onDescribeDataSetPermissionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeDataSetPermissions operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeDataSetRefreshPropertiesRequest.builder()
- Parameters:
describeDataSetRefreshPropertiesRequest
- AConsumer
that will call methods onDescribeDataSetRefreshPropertiesRequest.Builder
to create a request.- Returns:
- Result of the DescribeDataSetRefreshProperties operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeDataSourceRequest.builder()
- Parameters:
describeDataSourceRequest
- AConsumer
that will call methods onDescribeDataSourceRequest.Builder
to create a request.- Returns:
- Result of the DescribeDataSource operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeDataSourcePermissionsRequest.builder()
- Parameters:
describeDataSourcePermissionsRequest
- AConsumer
that will call methods onDescribeDataSourcePermissionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeDataSourcePermissions operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeFolderRequest.builder()
- Parameters:
describeFolderRequest
- AConsumer
that will call methods onDescribeFolderRequest.Builder
to create a request.- Returns:
- Result of the DescribeFolder operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeFolderPermissionsRequest.builder()
- Parameters:
describeFolderPermissionsRequest
- AConsumer
that will call methods onDescribeFolderPermissionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeFolderPermissions operation returned by the service.
- See Also:
-
describeFolderPermissionsPaginator
default DescribeFolderPermissionsIterable describeFolderPermissionsPaginator(DescribeFolderPermissionsRequest describeFolderPermissionsRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.DescribeFolderPermissionsIterable responses = client.describeFolderPermissionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
describeFolderPermissionsPaginator
default DescribeFolderPermissionsIterable describeFolderPermissionsPaginator(Consumer<DescribeFolderPermissionsRequest.Builder> describeFolderPermissionsRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.DescribeFolderPermissionsIterable responses = client.describeFolderPermissionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeFolderPermissionsRequest.builder()
- Parameters:
describeFolderPermissionsRequest
- AConsumer
that will call methods onDescribeFolderPermissionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaDescribeFolderResolvedPermissionsRequest.builder()
- Parameters:
describeFolderResolvedPermissionsRequest
- AConsumer
that will call methods onDescribeFolderResolvedPermissionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeFolderResolvedPermissions operation returned by the service.
- See Also:
-
describeFolderResolvedPermissionsPaginator
default DescribeFolderResolvedPermissionsIterable describeFolderResolvedPermissionsPaginator(DescribeFolderResolvedPermissionsRequest describeFolderResolvedPermissionsRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.DescribeFolderResolvedPermissionsIterable responses = client.describeFolderResolvedPermissionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
describeFolderResolvedPermissionsPaginator
default DescribeFolderResolvedPermissionsIterable describeFolderResolvedPermissionsPaginator(Consumer<DescribeFolderResolvedPermissionsRequest.Builder> describeFolderResolvedPermissionsRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.DescribeFolderResolvedPermissionsIterable responses = client.describeFolderResolvedPermissionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaDescribeFolderResolvedPermissionsRequest.builder()
- Parameters:
describeFolderResolvedPermissionsRequest
- AConsumer
that will call methods onDescribeFolderResolvedPermissionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaDescribeGroupRequest.builder()
- Parameters:
describeGroupRequest
- AConsumer
that will call methods onDescribeGroupRequest.Builder
to create a request.- Returns:
- Result of the DescribeGroup operation returned by the service.
- See Also:
-
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 associatedGroupMember
object is returned.- Parameters:
describeGroupMembershipRequest
-- Returns:
- Result of the DescribeGroupMembership operation returned by the service.
- See Also:
-
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 associatedGroupMember
object is returned.
This is a convenience which creates an instance of the
DescribeGroupMembershipRequest.Builder
avoiding the need to create one manually viaDescribeGroupMembershipRequest.builder()
- Parameters:
describeGroupMembershipRequest
- AConsumer
that will call methods onDescribeGroupMembershipRequest.Builder
to create a request.- Returns:
- Result of the DescribeGroupMembership operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeIamPolicyAssignmentRequest.builder()
- Parameters:
describeIamPolicyAssignmentRequest
- AConsumer
that will call methods onDescribeIamPolicyAssignmentRequest.Builder
to create a request.- Returns:
- Result of the DescribeIAMPolicyAssignment operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeIngestionRequest.builder()
- Parameters:
describeIngestionRequest
- AConsumer
that will call methods onDescribeIngestionRequest.Builder
to create a request.- Returns:
- Result of the DescribeIngestion operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeIpRestrictionRequest.builder()
- Parameters:
describeIpRestrictionRequest
- AConsumer
that will call methods onDescribeIpRestrictionRequest.Builder
to create a request.- Returns:
- Result of the DescribeIpRestriction operation returned by the service.
- See Also:
-
describeKeyRegistration
default DescribeKeyRegistrationResponse describeKeyRegistration(DescribeKeyRegistrationRequest describeKeyRegistrationRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException Describes all customer managed key registrations in a Amazon QuickSight account.
- Parameters:
describeKeyRegistrationRequest
-- Returns:
- Result of the DescribeKeyRegistration operation returned by the service.
- See Also:
-
describeKeyRegistration
default DescribeKeyRegistrationResponse describeKeyRegistration(Consumer<DescribeKeyRegistrationRequest.Builder> describeKeyRegistrationRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException Describes all customer managed key registrations in a Amazon QuickSight account.
This is a convenience which creates an instance of the
DescribeKeyRegistrationRequest.Builder
avoiding the need to create one manually viaDescribeKeyRegistrationRequest.builder()
- Parameters:
describeKeyRegistrationRequest
- AConsumer
that will call methods onDescribeKeyRegistrationRequest.Builder
to create a request.- Returns:
- Result of the DescribeKeyRegistration operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeNamespaceRequest.builder()
- Parameters:
describeNamespaceRequest
- AConsumer
that will call methods onDescribeNamespaceRequest.Builder
to create a request.- Returns:
- Result of the DescribeNamespace operation returned by the service.
- See Also:
-
describeQPersonalizationConfiguration
default DescribeQPersonalizationConfigurationResponse describeQPersonalizationConfiguration(DescribeQPersonalizationConfigurationRequest describeQPersonalizationConfigurationRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException Describes a personalization configuration.
- Parameters:
describeQPersonalizationConfigurationRequest
-- Returns:
- Result of the DescribeQPersonalizationConfiguration operation returned by the service.
- See Also:
-
describeQPersonalizationConfiguration
default DescribeQPersonalizationConfigurationResponse describeQPersonalizationConfiguration(Consumer<DescribeQPersonalizationConfigurationRequest.Builder> describeQPersonalizationConfigurationRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException Describes a personalization configuration.
This is a convenience which creates an instance of the
DescribeQPersonalizationConfigurationRequest.Builder
avoiding the need to create one manually viaDescribeQPersonalizationConfigurationRequest.builder()
- Parameters:
describeQPersonalizationConfigurationRequest
- AConsumer
that will call methods onDescribeQPersonalizationConfigurationRequest.Builder
to create a request.- Returns:
- Result of the DescribeQPersonalizationConfiguration operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeRefreshScheduleRequest.builder()
- Parameters:
describeRefreshScheduleRequest
- AConsumer
that will call methods onDescribeRefreshScheduleRequest.Builder
to create a request.- Returns:
- Result of the DescribeRefreshSchedule operation returned by the service.
- See Also:
-
describeRoleCustomPermission
default DescribeRoleCustomPermissionResponse describeRoleCustomPermission(DescribeRoleCustomPermissionRequest describeRoleCustomPermissionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException Describes all custom permissions that are mapped to a role.
- Parameters:
describeRoleCustomPermissionRequest
-- Returns:
- Result of the DescribeRoleCustomPermission operation returned by the service.
- See Also:
-
describeRoleCustomPermission
default DescribeRoleCustomPermissionResponse describeRoleCustomPermission(Consumer<DescribeRoleCustomPermissionRequest.Builder> describeRoleCustomPermissionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException Describes all custom permissions that are mapped to a role.
This is a convenience which creates an instance of the
DescribeRoleCustomPermissionRequest.Builder
avoiding the need to create one manually viaDescribeRoleCustomPermissionRequest.builder()
- Parameters:
describeRoleCustomPermissionRequest
- AConsumer
that will call methods onDescribeRoleCustomPermissionRequest.Builder
to create a request.- Returns:
- Result of the DescribeRoleCustomPermission operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeTemplateRequest.builder()
- Parameters:
describeTemplateRequest
- AConsumer
that will call methods onDescribeTemplateRequest.Builder
to create a request.- Returns:
- Result of the DescribeTemplate operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeTemplateAliasRequest.builder()
- Parameters:
describeTemplateAliasRequest
- AConsumer
that will call methods onDescribeTemplateAliasRequest.Builder
to create a request.- Returns:
- Result of the DescribeTemplateAlias operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeTemplateDefinitionRequest.builder()
- Parameters:
describeTemplateDefinitionRequest
- AConsumer
that will call methods onDescribeTemplateDefinitionRequest.Builder
to create a request.- Returns:
- Result of the DescribeTemplateDefinition operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeTemplatePermissionsRequest.builder()
- Parameters:
describeTemplatePermissionsRequest
- AConsumer
that will call methods onDescribeTemplatePermissionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeTemplatePermissions operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeThemeRequest.builder()
- Parameters:
describeThemeRequest
- AConsumer
that will call methods onDescribeThemeRequest.Builder
to create a request.- Returns:
- Result of the DescribeTheme operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeThemeAliasRequest.builder()
- Parameters:
describeThemeAliasRequest
- AConsumer
that will call methods onDescribeThemeAliasRequest.Builder
to create a request.- Returns:
- Result of the DescribeThemeAlias operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeThemePermissionsRequest.builder()
- Parameters:
describeThemePermissionsRequest
- AConsumer
that will call methods onDescribeThemePermissionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeThemePermissions operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeTopicRequest.builder()
- Parameters:
describeTopicRequest
- AConsumer
that will call methods onDescribeTopicRequest.Builder
to create a request.- Returns:
- Result of the DescribeTopic operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeTopicPermissionsRequest.builder()
- Parameters:
describeTopicPermissionsRequest
- AConsumer
that will call methods onDescribeTopicPermissionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeTopicPermissions operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeTopicRefreshRequest.builder()
- Parameters:
describeTopicRefreshRequest
- AConsumer
that will call methods onDescribeTopicRefreshRequest.Builder
to create a request.- Returns:
- Result of the DescribeTopicRefresh operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeTopicRefreshScheduleRequest.builder()
- Parameters:
describeTopicRefreshScheduleRequest
- AConsumer
that will call methods onDescribeTopicRefreshScheduleRequest.Builder
to create a request.- Returns:
- Result of the DescribeTopicRefreshSchedule operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeUserRequest.builder()
- Parameters:
describeUserRequest
- AConsumer
that will call methods onDescribeUserRequest.Builder
to create a request.- Returns:
- Result of the DescribeUser operation returned by the service.
- See Also:
-
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:
-
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 viaDescribeVpcConnectionRequest.builder()
- Parameters:
describeVpcConnectionRequest
- AConsumer
that will call methods onDescribeVpcConnectionRequest.Builder
to create a request.- Returns:
- Result of the DescribeVPCConnection operation returned by the service.
- See Also:
-
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:
-
-
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 viaGenerateEmbedUrlForAnonymousUserRequest.builder()
- Parameters:
generateEmbedUrlForAnonymousUserRequest
- AConsumer
that will call methods onGenerateEmbedUrlForAnonymousUserRequest.Builder
to create a request.- Returns:
- Result of the GenerateEmbedUrlForAnonymousUser operation returned by the service.
- See Also:
-
-
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:
-
-
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 viaGenerateEmbedUrlForRegisteredUserRequest.builder()
- Parameters:
generateEmbedUrlForRegisteredUserRequest
- AConsumer
that will call methods onGenerateEmbedUrlForRegisteredUserRequest.Builder
to create a request.- Returns:
- Result of the GenerateEmbedUrlForRegisteredUser operation returned by the service.
- See Also:
-
-
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:
-
-
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 viaGetDashboardEmbedUrlRequest.builder()
- Parameters:
getDashboardEmbedUrlRequest
- AConsumer
that will call methods onGetDashboardEmbedUrlRequest.Builder
to create a request.- Returns:
- Result of the GetDashboardEmbedUrl operation returned by the service.
- See Also:
-
-
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 theUpdateUser
API operation. UseRegisterUser
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:- Parameters:
getSessionEmbedUrlRequest
-- Returns:
- Result of the GetSessionEmbedUrl operation returned by the service.
- See Also:
-
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 theUpdateUser
API operation. UseRegisterUser
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:
This is a convenience which creates an instance of the
GetSessionEmbedUrlRequest.Builder
avoiding the need to create one manually viaGetSessionEmbedUrlRequest.builder()
- Parameters:
getSessionEmbedUrlRequest
- AConsumer
that will call methods onGetSessionEmbedUrlRequest.Builder
to create a request.- Returns:
- Result of the GetSessionEmbedUrl operation returned by the service.
- See Also:
-
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:
-
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 viaListAnalysesRequest.builder()
- Parameters:
listAnalysesRequest
- AConsumer
that will call methods onListAnalysesRequest.Builder
to create a request.- Returns:
- Result of the ListAnalyses operation returned by the service.
- See Also:
-
listAnalysesPaginator
default ListAnalysesIterable listAnalysesPaginator(ListAnalysesRequest listAnalysesRequest) throws ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListAnalysesIterable responses = client.listAnalysesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
listAnalysesPaginator
default ListAnalysesIterable listAnalysesPaginator(Consumer<ListAnalysesRequest.Builder> listAnalysesRequest) throws ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListAnalysesIterable responses = client.listAnalysesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListAnalysesRequest.builder()
- Parameters:
listAnalysesRequest
- AConsumer
that will call methods onListAnalysesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaListAssetBundleExportJobsRequest.builder()
- Parameters:
listAssetBundleExportJobsRequest
- AConsumer
that will call methods onListAssetBundleExportJobsRequest.Builder
to create a request.- Returns:
- Result of the ListAssetBundleExportJobs operation returned by the service.
- See Also:
-
listAssetBundleExportJobsPaginator
default ListAssetBundleExportJobsIterable listAssetBundleExportJobsPaginator(ListAssetBundleExportJobsRequest listAssetBundleExportJobsRequest) throws UnsupportedUserEditionException, ThrottlingException, AccessDeniedException, InvalidNextTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListAssetBundleExportJobsIterable responses = client.listAssetBundleExportJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
listAssetBundleExportJobsPaginator
default ListAssetBundleExportJobsIterable listAssetBundleExportJobsPaginator(Consumer<ListAssetBundleExportJobsRequest.Builder> listAssetBundleExportJobsRequest) throws UnsupportedUserEditionException, ThrottlingException, AccessDeniedException, InvalidNextTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListAssetBundleExportJobsIterable responses = client.listAssetBundleExportJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListAssetBundleExportJobsRequest.builder()
- Parameters:
listAssetBundleExportJobsRequest
- AConsumer
that will call methods onListAssetBundleExportJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaListAssetBundleImportJobsRequest.builder()
- Parameters:
listAssetBundleImportJobsRequest
- AConsumer
that will call methods onListAssetBundleImportJobsRequest.Builder
to create a request.- Returns:
- Result of the ListAssetBundleImportJobs operation returned by the service.
- See Also:
-
listAssetBundleImportJobsPaginator
default ListAssetBundleImportJobsIterable listAssetBundleImportJobsPaginator(ListAssetBundleImportJobsRequest listAssetBundleImportJobsRequest) throws UnsupportedUserEditionException, ThrottlingException, AccessDeniedException, InvalidNextTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListAssetBundleImportJobsIterable responses = client.listAssetBundleImportJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
listAssetBundleImportJobsPaginator
default ListAssetBundleImportJobsIterable listAssetBundleImportJobsPaginator(Consumer<ListAssetBundleImportJobsRequest.Builder> listAssetBundleImportJobsRequest) throws UnsupportedUserEditionException, ThrottlingException, AccessDeniedException, InvalidNextTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListAssetBundleImportJobsIterable responses = client.listAssetBundleImportJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListAssetBundleImportJobsRequest.builder()
- Parameters:
listAssetBundleImportJobsRequest
- AConsumer
that will call methods onListAssetBundleImportJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaListDashboardVersionsRequest.builder()
- Parameters:
listDashboardVersionsRequest
- AConsumer
that will call methods onListDashboardVersionsRequest.Builder
to create a request.- Returns:
- Result of the ListDashboardVersions operation returned by the service.
- See Also:
-
listDashboardVersionsPaginator
default ListDashboardVersionsIterable listDashboardVersionsPaginator(ListDashboardVersionsRequest listDashboardVersionsRequest) throws InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsIterable responses = client.listDashboardVersionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
listDashboardVersionsPaginator
default ListDashboardVersionsIterable listDashboardVersionsPaginator(Consumer<ListDashboardVersionsRequest.Builder> listDashboardVersionsRequest) throws InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsIterable responses = client.listDashboardVersionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListDashboardVersionsRequest.builder()
- Parameters:
listDashboardVersionsRequest
- AConsumer
that will call methods onListDashboardVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaListDashboardsRequest.builder()
- Parameters:
listDashboardsRequest
- AConsumer
that will call methods onListDashboardsRequest.Builder
to create a request.- Returns:
- Result of the ListDashboards operation returned by the service.
- See Also:
-
listDashboardsPaginator
default ListDashboardsIterable listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest) throws ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
listDashboardsPaginator
default ListDashboardsIterable listDashboardsPaginator(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest) throws ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListDashboardsRequest.builder()
- Parameters:
listDashboardsRequest
- AConsumer
that will call methods onListDashboardsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaListDataSetsRequest.builder()
- Parameters:
listDataSetsRequest
- AConsumer
that will call methods onListDataSetsRequest.Builder
to create a request.- Returns:
- Result of the ListDataSets operation returned by the service.
- See Also:
-
listDataSetsPaginator
default ListDataSetsIterable listDataSetsPaginator(ListDataSetsRequest listDataSetsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
listDataSetsPaginator
default ListDataSetsIterable listDataSetsPaginator(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListDataSetsRequest.builder()
- Parameters:
listDataSetsRequest
- AConsumer
that will call methods onListDataSetsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaListDataSourcesRequest.builder()
- Parameters:
listDataSourcesRequest
- AConsumer
that will call methods onListDataSourcesRequest.Builder
to create a request.- Returns:
- Result of the ListDataSources operation returned by the service.
- See Also:
-
listDataSourcesPaginator
default ListDataSourcesIterable listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
listDataSourcesPaginator
default ListDataSourcesIterable listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListDataSourcesRequest.builder()
- Parameters:
listDataSourcesRequest
- AConsumer
that will call methods onListDataSourcesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFolderMembers
default ListFolderMembersResponse listFolderMembers(ListFolderMembersRequest listFolderMembersRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException List all assets (
DASHBOARD
,ANALYSIS
, andDATASET
) in a folder.- Parameters:
listFolderMembersRequest
-- Returns:
- Result of the ListFolderMembers operation returned by the service.
- See Also:
-
listFolderMembers
default ListFolderMembersResponse listFolderMembers(Consumer<ListFolderMembersRequest.Builder> listFolderMembersRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException List all assets (
DASHBOARD
,ANALYSIS
, andDATASET
) in a folder.
This is a convenience which creates an instance of the
ListFolderMembersRequest.Builder
avoiding the need to create one manually viaListFolderMembersRequest.builder()
- Parameters:
listFolderMembersRequest
- AConsumer
that will call methods onListFolderMembersRequest.Builder
to create a request.- Returns:
- Result of the ListFolderMembers operation returned by the service.
- See Also:
-
listFolderMembersPaginator
default ListFolderMembersIterable listFolderMembersPaginator(ListFolderMembersRequest listFolderMembersRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListFolderMembersIterable responses = client.listFolderMembersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
listFolderMembersPaginator
default ListFolderMembersIterable listFolderMembersPaginator(Consumer<ListFolderMembersRequest.Builder> listFolderMembersRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListFolderMembersIterable responses = client.listFolderMembersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListFolderMembersRequest.builder()
- Parameters:
listFolderMembersRequest
- AConsumer
that will call methods onListFolderMembersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaListFoldersRequest.builder()
- Parameters:
listFoldersRequest
- AConsumer
that will call methods onListFoldersRequest.Builder
to create a request.- Returns:
- Result of the ListFolders operation returned by the service.
- See Also:
-
listFoldersPaginator
default ListFoldersIterable listFoldersPaginator(ListFoldersRequest listFoldersRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListFoldersIterable responses = client.listFoldersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
listFoldersPaginator
default ListFoldersIterable listFoldersPaginator(Consumer<ListFoldersRequest.Builder> listFoldersRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListFoldersIterable responses = client.listFoldersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListFoldersRequest.builder()
- Parameters:
listFoldersRequest
- AConsumer
that will call methods onListFoldersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFoldersForResource
default ListFoldersForResourceResponse listFoldersForResource(ListFoldersForResourceRequest listFoldersForResourceRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException List all folders that a resource is a member of.
- Parameters:
listFoldersForResourceRequest
-- Returns:
- Result of the ListFoldersForResource operation returned by the service.
- See Also:
-
listFoldersForResource
default ListFoldersForResourceResponse listFoldersForResource(Consumer<ListFoldersForResourceRequest.Builder> listFoldersForResourceRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException List all folders that a resource is a member of.
This is a convenience which creates an instance of the
ListFoldersForResourceRequest.Builder
avoiding the need to create one manually viaListFoldersForResourceRequest.builder()
- Parameters:
listFoldersForResourceRequest
- AConsumer
that will call methods onListFoldersForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListFoldersForResource operation returned by the service.
- See Also:
-
listFoldersForResourcePaginator
default ListFoldersForResourceIterable listFoldersForResourcePaginator(ListFoldersForResourceRequest listFoldersForResourceRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException This is a variant of
listFoldersForResource(software.amazon.awssdk.services.quicksight.model.ListFoldersForResourceRequest)
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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListFoldersForResourceIterable responses = client.listFoldersForResourcePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.quicksight.paginators.ListFoldersForResourceIterable responses = client .listFoldersForResourcePaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListFoldersForResourceResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListFoldersForResourceIterable responses = client.listFoldersForResourcePaginator(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
listFoldersForResource(software.amazon.awssdk.services.quicksight.model.ListFoldersForResourceRequest)
operation.- Parameters:
listFoldersForResourceRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFoldersForResourcePaginator
default ListFoldersForResourceIterable listFoldersForResourcePaginator(Consumer<ListFoldersForResourceRequest.Builder> listFoldersForResourceRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException This is a variant of
listFoldersForResource(software.amazon.awssdk.services.quicksight.model.ListFoldersForResourceRequest)
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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListFoldersForResourceIterable responses = client.listFoldersForResourcePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.quicksight.paginators.ListFoldersForResourceIterable responses = client .listFoldersForResourcePaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListFoldersForResourceResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListFoldersForResourceIterable responses = client.listFoldersForResourcePaginator(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
listFoldersForResource(software.amazon.awssdk.services.quicksight.model.ListFoldersForResourceRequest)
operation.
This is a convenience which creates an instance of the
ListFoldersForResourceRequest.Builder
avoiding the need to create one manually viaListFoldersForResourceRequest.builder()
- Parameters:
listFoldersForResourceRequest
- AConsumer
that will call methods onListFoldersForResourceRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaListGroupMembershipsRequest.builder()
- Parameters:
listGroupMembershipsRequest
- AConsumer
that will call methods onListGroupMembershipsRequest.Builder
to create a request.- Returns:
- Result of the ListGroupMemberships operation returned by the service.
- See Also:
-
listGroupMembershipsPaginator
default ListGroupMembershipsIterable listGroupMembershipsPaginator(ListGroupMembershipsRequest listGroupMembershipsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListGroupMembershipsIterable responses = client.listGroupMembershipsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
listGroupMembershipsPaginator
default ListGroupMembershipsIterable listGroupMembershipsPaginator(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListGroupMembershipsIterable responses = client.listGroupMembershipsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListGroupMembershipsRequest.builder()
- Parameters:
listGroupMembershipsRequest
- AConsumer
that will call methods onListGroupMembershipsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaListGroupsRequest.builder()
- Parameters:
listGroupsRequest
- AConsumer
that will call methods onListGroupsRequest.Builder
to create a request.- Returns:
- Result of the ListGroups operation returned by the service.
- See Also:
-
listGroupsPaginator
default ListGroupsIterable listGroupsPaginator(ListGroupsRequest listGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
listGroupsPaginator
default ListGroupsIterable listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListGroupsRequest.builder()
- Parameters:
listGroupsRequest
- AConsumer
that will call methods onListGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaListIamPolicyAssignmentsRequest.builder()
- Parameters:
listIamPolicyAssignmentsRequest
- AConsumer
that will call methods onListIamPolicyAssignmentsRequest.Builder
to create a request.- Returns:
- Result of the ListIAMPolicyAssignments operation returned by the service.
- See Also:
-
listIAMPolicyAssignmentsPaginator
default ListIAMPolicyAssignmentsIterable listIAMPolicyAssignmentsPaginator(ListIamPolicyAssignmentsRequest listIamPolicyAssignmentsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsIterable responses = client.listIAMPolicyAssignmentsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
listIAMPolicyAssignmentsPaginator
default ListIAMPolicyAssignmentsIterable listIAMPolicyAssignmentsPaginator(Consumer<ListIamPolicyAssignmentsRequest.Builder> listIamPolicyAssignmentsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsIterable responses = client.listIAMPolicyAssignmentsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListIamPolicyAssignmentsRequest.builder()
- Parameters:
listIamPolicyAssignmentsRequest
- AConsumer
that will call methods onListIamPolicyAssignmentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaListIamPolicyAssignmentsForUserRequest.builder()
- Parameters:
listIamPolicyAssignmentsForUserRequest
- AConsumer
that will call methods onListIamPolicyAssignmentsForUserRequest.Builder
to create a request.- Returns:
- Result of the ListIAMPolicyAssignmentsForUser operation returned by the service.
- See Also:
-
listIAMPolicyAssignmentsForUserPaginator
default ListIAMPolicyAssignmentsForUserIterable listIAMPolicyAssignmentsForUserPaginator(ListIamPolicyAssignmentsForUserRequest listIamPolicyAssignmentsForUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConcurrentUpdatingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsForUserIterable responses = client.listIAMPolicyAssignmentsForUserPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
listIAMPolicyAssignmentsForUserPaginator
default ListIAMPolicyAssignmentsForUserIterable listIAMPolicyAssignmentsForUserPaginator(Consumer<ListIamPolicyAssignmentsForUserRequest.Builder> listIamPolicyAssignmentsForUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConcurrentUpdatingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsForUserIterable responses = client.listIAMPolicyAssignmentsForUserPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListIamPolicyAssignmentsForUserRequest.builder()
- Parameters:
listIamPolicyAssignmentsForUserRequest
- AConsumer
that will call methods onListIamPolicyAssignmentsForUserRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listIdentityPropagationConfigs
default ListIdentityPropagationConfigsResponse listIdentityPropagationConfigs(ListIdentityPropagationConfigsRequest listIdentityPropagationConfigsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access.
This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.
- Parameters:
listIdentityPropagationConfigsRequest
-- Returns:
- Result of the ListIdentityPropagationConfigs operation returned by the service.
- See Also:
-
listIdentityPropagationConfigs
default ListIdentityPropagationConfigsResponse listIdentityPropagationConfigs(Consumer<ListIdentityPropagationConfigsRequest.Builder> listIdentityPropagationConfigsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access.
This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.
This is a convenience which creates an instance of the
ListIdentityPropagationConfigsRequest.Builder
avoiding the need to create one manually viaListIdentityPropagationConfigsRequest.builder()
- Parameters:
listIdentityPropagationConfigsRequest
- AConsumer
that will call methods onListIdentityPropagationConfigsRequest.Builder
to create a request.- Returns:
- Result of the ListIdentityPropagationConfigs operation returned by the service.
- See Also:
-
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:
-
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 viaListIngestionsRequest.builder()
- Parameters:
listIngestionsRequest
- AConsumer
that will call methods onListIngestionsRequest.Builder
to create a request.- Returns:
- Result of the ListIngestions operation returned by the service.
- See Also:
-
listIngestionsPaginator
default ListIngestionsIterable listIngestionsPaginator(ListIngestionsRequest listIngestionsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ResourceExistsException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListIngestionsIterable responses = client.listIngestionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
listIngestionsPaginator
default ListIngestionsIterable listIngestionsPaginator(Consumer<ListIngestionsRequest.Builder> listIngestionsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ResourceExistsException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListIngestionsIterable responses = client.listIngestionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListIngestionsRequest.builder()
- Parameters:
listIngestionsRequest
- AConsumer
that will call methods onListIngestionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaListNamespacesRequest.builder()
- Parameters:
listNamespacesRequest
- AConsumer
that will call methods onListNamespacesRequest.Builder
to create a request.- Returns:
- Result of the ListNamespaces operation returned by the service.
- See Also:
-
listNamespacesPaginator
default ListNamespacesIterable listNamespacesPaginator(ListNamespacesRequest listNamespacesRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListNamespacesIterable responses = client.listNamespacesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
listNamespacesPaginator
default ListNamespacesIterable listNamespacesPaginator(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListNamespacesIterable responses = client.listNamespacesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListNamespacesRequest.builder()
- Parameters:
listNamespacesRequest
- AConsumer
that will call methods onListNamespacesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaListRefreshSchedulesRequest.builder()
- Parameters:
listRefreshSchedulesRequest
- AConsumer
that will call methods onListRefreshSchedulesRequest.Builder
to create a request.- Returns:
- Result of the ListRefreshSchedules operation returned by the service.
- See Also:
-
listRoleMemberships
default ListRoleMembershipsResponse listRoleMemberships(ListRoleMembershipsRequest listRoleMembershipsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, LimitExceededException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException Lists all groups that are associated with a role.
- Parameters:
listRoleMembershipsRequest
-- Returns:
- Result of the ListRoleMemberships operation returned by the service.
- See Also:
-
listRoleMemberships
default ListRoleMembershipsResponse listRoleMemberships(Consumer<ListRoleMembershipsRequest.Builder> listRoleMembershipsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, LimitExceededException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException Lists all groups that are associated with a role.
This is a convenience which creates an instance of the
ListRoleMembershipsRequest.Builder
avoiding the need to create one manually viaListRoleMembershipsRequest.builder()
- Parameters:
listRoleMembershipsRequest
- AConsumer
that will call methods onListRoleMembershipsRequest.Builder
to create a request.- Returns:
- Result of the ListRoleMemberships operation returned by the service.
- See Also:
-
listRoleMembershipsPaginator
default ListRoleMembershipsIterable listRoleMembershipsPaginator(ListRoleMembershipsRequest listRoleMembershipsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, LimitExceededException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException This is a variant of
listRoleMemberships(software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsRequest)
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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListRoleMembershipsIterable responses = client.listRoleMembershipsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.quicksight.paginators.ListRoleMembershipsIterable responses = client .listRoleMembershipsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListRoleMembershipsIterable responses = client.listRoleMembershipsPaginator(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
listRoleMemberships(software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsRequest)
operation.- Parameters:
listRoleMembershipsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRoleMembershipsPaginator
default ListRoleMembershipsIterable listRoleMembershipsPaginator(Consumer<ListRoleMembershipsRequest.Builder> listRoleMembershipsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, LimitExceededException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException This is a variant of
listRoleMemberships(software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsRequest)
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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListRoleMembershipsIterable responses = client.listRoleMembershipsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.quicksight.paginators.ListRoleMembershipsIterable responses = client .listRoleMembershipsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListRoleMembershipsIterable responses = client.listRoleMembershipsPaginator(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
listRoleMemberships(software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsRequest)
operation.
This is a convenience which creates an instance of the
ListRoleMembershipsRequest.Builder
avoiding the need to create one manually viaListRoleMembershipsRequest.builder()
- Parameters:
listRoleMembershipsRequest
- AConsumer
that will call methods onListRoleMembershipsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
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:
-
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 viaListTemplateAliasesRequest.builder()
- Parameters:
listTemplateAliasesRequest
- AConsumer
that will call methods onListTemplateAliasesRequest.Builder
to create a request.- Returns:
- Result of the ListTemplateAliases operation returned by the service.
- See Also:
-
listTemplateAliasesPaginator
default ListTemplateAliasesIterable listTemplateAliasesPaginator(ListTemplateAliasesRequest listTemplateAliasesRequest) throws InvalidNextTokenException, ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesIterable responses = client.listTemplateAliasesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
listTemplateAliasesPaginator
default ListTemplateAliasesIterable listTemplateAliasesPaginator(Consumer<ListTemplateAliasesRequest.Builder> listTemplateAliasesRequest) throws InvalidNextTokenException, ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesIterable responses = client.listTemplateAliasesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListTemplateAliasesRequest.builder()
- Parameters:
listTemplateAliasesRequest
- AConsumer
that will call methods onListTemplateAliasesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaListTemplateVersionsRequest.builder()
- Parameters:
listTemplateVersionsRequest
- AConsumer
that will call methods onListTemplateVersionsRequest.Builder
to create a request.- Returns:
- Result of the ListTemplateVersions operation returned by the service.
- See Also:
-
listTemplateVersionsPaginator
default ListTemplateVersionsIterable listTemplateVersionsPaginator(ListTemplateVersionsRequest listTemplateVersionsRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsIterable responses = client.listTemplateVersionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
listTemplateVersionsPaginator
default ListTemplateVersionsIterable listTemplateVersionsPaginator(Consumer<ListTemplateVersionsRequest.Builder> listTemplateVersionsRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsIterable responses = client.listTemplateVersionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListTemplateVersionsRequest.builder()
- Parameters:
listTemplateVersionsRequest
- AConsumer
that will call methods onListTemplateVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaListTemplatesRequest.builder()
- Parameters:
listTemplatesRequest
- AConsumer
that will call methods onListTemplatesRequest.Builder
to create a request.- Returns:
- Result of the ListTemplates operation returned by the service.
- See Also:
-
listTemplatesPaginator
default ListTemplatesIterable listTemplatesPaginator(ListTemplatesRequest listTemplatesRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
listTemplatesPaginator
default ListTemplatesIterable listTemplatesPaginator(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListTemplatesRequest.builder()
- Parameters:
listTemplatesRequest
- AConsumer
that will call methods onListTemplatesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaListThemeAliasesRequest.builder()
- Parameters:
listThemeAliasesRequest
- AConsumer
that will call methods onListThemeAliasesRequest.Builder
to create a request.- Returns:
- Result of the ListThemeAliases operation returned by the service.
- See Also:
-
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:
-
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 viaListThemeVersionsRequest.builder()
- Parameters:
listThemeVersionsRequest
- AConsumer
that will call methods onListThemeVersionsRequest.Builder
to create a request.- Returns:
- Result of the ListThemeVersions operation returned by the service.
- See Also:
-
listThemeVersionsPaginator
default ListThemeVersionsIterable listThemeVersionsPaginator(ListThemeVersionsRequest listThemeVersionsRequest) throws AccessDeniedException, InvalidNextTokenException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListThemeVersionsIterable responses = client.listThemeVersionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
listThemeVersionsPaginator
default ListThemeVersionsIterable listThemeVersionsPaginator(Consumer<ListThemeVersionsRequest.Builder> listThemeVersionsRequest) throws AccessDeniedException, InvalidNextTokenException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListThemeVersionsIterable responses = client.listThemeVersionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListThemeVersionsRequest.builder()
- Parameters:
listThemeVersionsRequest
- AConsumer
that will call methods onListThemeVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaListThemesRequest.builder()
- Parameters:
listThemesRequest
- AConsumer
that will call methods onListThemesRequest.Builder
to create a request.- Returns:
- Result of the ListThemes operation returned by the service.
- See Also:
-
listThemesPaginator
default ListThemesIterable listThemesPaginator(ListThemesRequest listThemesRequest) throws AccessDeniedException, InvalidParameterValueException, InvalidNextTokenException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListThemesIterable responses = client.listThemesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
listThemesPaginator
default ListThemesIterable listThemesPaginator(Consumer<ListThemesRequest.Builder> listThemesRequest) throws AccessDeniedException, InvalidParameterValueException, InvalidNextTokenException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListThemesIterable responses = client.listThemesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListThemesRequest.builder()
- Parameters:
listThemesRequest
- AConsumer
that will call methods onListThemesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaListTopicRefreshSchedulesRequest.builder()
- Parameters:
listTopicRefreshSchedulesRequest
- AConsumer
that will call methods onListTopicRefreshSchedulesRequest.Builder
to create a request.- Returns:
- Result of the ListTopicRefreshSchedules operation returned by the service.
- See Also:
-
listTopicReviewedAnswers
default ListTopicReviewedAnswersResponse listTopicReviewedAnswers(ListTopicReviewedAnswersRequest listTopicReviewedAnswersRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException Lists all reviewed answers for a Q Topic.
- Parameters:
listTopicReviewedAnswersRequest
-- Returns:
- Result of the ListTopicReviewedAnswers operation returned by the service.
- See Also:
-
listTopicReviewedAnswers
default ListTopicReviewedAnswersResponse listTopicReviewedAnswers(Consumer<ListTopicReviewedAnswersRequest.Builder> listTopicReviewedAnswersRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException Lists all reviewed answers for a Q Topic.
This is a convenience which creates an instance of the
ListTopicReviewedAnswersRequest.Builder
avoiding the need to create one manually viaListTopicReviewedAnswersRequest.builder()
- Parameters:
listTopicReviewedAnswersRequest
- AConsumer
that will call methods onListTopicReviewedAnswersRequest.Builder
to create a request.- Returns:
- Result of the ListTopicReviewedAnswers operation returned by the service.
- See Also:
-
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:
-
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 viaListTopicsRequest.builder()
- Parameters:
listTopicsRequest
- AConsumer
that will call methods onListTopicsRequest.Builder
to create a request.- Returns:
- Result of the ListTopics operation returned by the service.
- See Also:
-
listTopicsPaginator
default ListTopicsIterable listTopicsPaginator(ListTopicsRequest listTopicsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListTopicsIterable responses = client.listTopicsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
listTopicsPaginator
default ListTopicsIterable listTopicsPaginator(Consumer<ListTopicsRequest.Builder> listTopicsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListTopicsIterable responses = client.listTopicsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListTopicsRequest.builder()
- Parameters:
listTopicsRequest
- AConsumer
that will call methods onListTopicsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaListUserGroupsRequest.builder()
- Parameters:
listUserGroupsRequest
- AConsumer
that will call methods onListUserGroupsRequest.Builder
to create a request.- Returns:
- Result of the ListUserGroups operation returned by the service.
- See Also:
-
listUserGroupsPaginator
default ListUserGroupsIterable listUserGroupsPaginator(ListUserGroupsRequest listUserGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListUserGroupsIterable responses = client.listUserGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
listUserGroupsPaginator
default ListUserGroupsIterable listUserGroupsPaginator(Consumer<ListUserGroupsRequest.Builder> listUserGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListUserGroupsIterable responses = client.listUserGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListUserGroupsRequest.builder()
- Parameters:
listUserGroupsRequest
- AConsumer
that will call methods onListUserGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaListUsersRequest.builder()
- Parameters:
listUsersRequest
- AConsumer
that will call methods onListUsersRequest.Builder
to create a request.- Returns:
- Result of the ListUsers operation returned by the service.
- See Also:
-
listUsersPaginator
default ListUsersIterable listUsersPaginator(ListUsersRequest listUsersRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
listUsersPaginator
default ListUsersIterable listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListUsersRequest.builder()
- Parameters:
listUsersRequest
- AConsumer
that will call methods onListUsersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaListVpcConnectionsRequest.builder()
- Parameters:
listVpcConnectionsRequest
- AConsumer
that will call methods onListVpcConnectionsRequest.Builder
to create a request.- Returns:
- Result of the ListVPCConnections operation returned by the service.
- See Also:
-
listVPCConnectionsPaginator
default ListVPCConnectionsIterable listVPCConnectionsPaginator(ListVpcConnectionsRequest listVpcConnectionsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListVPCConnectionsIterable responses = client.listVPCConnectionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
listVPCConnectionsPaginator
default ListVPCConnectionsIterable listVPCConnectionsPaginator(Consumer<ListVpcConnectionsRequest.Builder> listVpcConnectionsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.ListVPCConnectionsIterable responses = client.listVPCConnectionsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListVpcConnectionsRequest.builder()
- Parameters:
listVpcConnectionsRequest
- AConsumer
that will call methods onListVpcConnectionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaPutDataSetRefreshPropertiesRequest.builder()
- Parameters:
putDataSetRefreshPropertiesRequest
- AConsumer
that will call methods onPutDataSetRefreshPropertiesRequest.Builder
to create a request.- Returns:
- Result of the PutDataSetRefreshProperties operation returned by the service.
- See Also:
-
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:
-
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 viaRegisterUserRequest.builder()
- Parameters:
registerUserRequest
- AConsumer
that will call methods onRegisterUserRequest.Builder
to create a request.- Returns:
- Result of the RegisterUser operation returned by the service.
- See Also:
-
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:
-
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 viaRestoreAnalysisRequest.builder()
- Parameters:
restoreAnalysisRequest
- AConsumer
that will call methods onRestoreAnalysisRequest.Builder
to create a request.- Returns:
- Result of the RestoreAnalysis operation returned by the service.
- See Also:
-
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:
-
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 viaSearchAnalysesRequest.builder()
- Parameters:
searchAnalysesRequest
- AConsumer
that will call methods onSearchAnalysesRequest.Builder
to create a request.- Returns:
- Result of the SearchAnalyses operation returned by the service.
- See Also:
-
searchAnalysesPaginator
default SearchAnalysesIterable searchAnalysesPaginator(SearchAnalysesRequest searchAnalysesRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.SearchAnalysesIterable responses = client.searchAnalysesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
searchAnalysesPaginator
default SearchAnalysesIterable searchAnalysesPaginator(Consumer<SearchAnalysesRequest.Builder> searchAnalysesRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.SearchAnalysesIterable responses = client.searchAnalysesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaSearchAnalysesRequest.builder()
- Parameters:
searchAnalysesRequest
- AConsumer
that will call methods onSearchAnalysesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaSearchDashboardsRequest.builder()
- Parameters:
searchDashboardsRequest
- AConsumer
that will call methods onSearchDashboardsRequest.Builder
to create a request.- Returns:
- Result of the SearchDashboards operation returned by the service.
- See Also:
-
searchDashboardsPaginator
default SearchDashboardsIterable searchDashboardsPaginator(SearchDashboardsRequest searchDashboardsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.SearchDashboardsIterable responses = client.searchDashboardsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
searchDashboardsPaginator
default SearchDashboardsIterable searchDashboardsPaginator(Consumer<SearchDashboardsRequest.Builder> searchDashboardsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.SearchDashboardsIterable responses = client.searchDashboardsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaSearchDashboardsRequest.builder()
- Parameters:
searchDashboardsRequest
- AConsumer
that will call methods onSearchDashboardsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaSearchDataSetsRequest.builder()
- Parameters:
searchDataSetsRequest
- AConsumer
that will call methods onSearchDataSetsRequest.Builder
to create a request.- Returns:
- Result of the SearchDataSets operation returned by the service.
- See Also:
-
searchDataSetsPaginator
default SearchDataSetsIterable searchDataSetsPaginator(SearchDataSetsRequest searchDataSetsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, AccessDeniedException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.SearchDataSetsIterable responses = client.searchDataSetsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
searchDataSetsPaginator
default SearchDataSetsIterable searchDataSetsPaginator(Consumer<SearchDataSetsRequest.Builder> searchDataSetsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, AccessDeniedException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.SearchDataSetsIterable responses = client.searchDataSetsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaSearchDataSetsRequest.builder()
- Parameters:
searchDataSetsRequest
- AConsumer
that will call methods onSearchDataSetsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaSearchDataSourcesRequest.builder()
- Parameters:
searchDataSourcesRequest
- AConsumer
that will call methods onSearchDataSourcesRequest.Builder
to create a request.- Returns:
- Result of the SearchDataSources operation returned by the service.
- See Also:
-
searchDataSourcesPaginator
default SearchDataSourcesIterable searchDataSourcesPaginator(SearchDataSourcesRequest searchDataSourcesRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, AccessDeniedException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.SearchDataSourcesIterable responses = client.searchDataSourcesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
searchDataSourcesPaginator
default SearchDataSourcesIterable searchDataSourcesPaginator(Consumer<SearchDataSourcesRequest.Builder> searchDataSourcesRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, AccessDeniedException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.SearchDataSourcesIterable responses = client.searchDataSourcesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaSearchDataSourcesRequest.builder()
- Parameters:
searchDataSourcesRequest
- AConsumer
that will call methods onSearchDataSourcesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaSearchFoldersRequest.builder()
- Parameters:
searchFoldersRequest
- AConsumer
that will call methods onSearchFoldersRequest.Builder
to create a request.- Returns:
- Result of the SearchFolders operation returned by the service.
- See Also:
-
searchFoldersPaginator
default SearchFoldersIterable searchFoldersPaginator(SearchFoldersRequest searchFoldersRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InvalidRequestException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.SearchFoldersIterable responses = client.searchFoldersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
searchFoldersPaginator
default SearchFoldersIterable searchFoldersPaginator(Consumer<SearchFoldersRequest.Builder> searchFoldersRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InvalidRequestException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.SearchFoldersIterable responses = client.searchFoldersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaSearchFoldersRequest.builder()
- Parameters:
searchFoldersRequest
- AConsumer
that will call methods onSearchFoldersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaSearchGroupsRequest.builder()
- Parameters:
searchGroupsRequest
- AConsumer
that will call methods onSearchGroupsRequest.Builder
to create a request.- Returns:
- Result of the SearchGroups operation returned by the service.
- See Also:
-
searchGroupsPaginator
default SearchGroupsIterable searchGroupsPaginator(SearchGroupsRequest searchGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.SearchGroupsIterable responses = client.searchGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
searchGroupsPaginator
default SearchGroupsIterable searchGroupsPaginator(Consumer<SearchGroupsRequest.Builder> searchGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException 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 Streamsoftware.amazon.awssdk.services.quicksight.paginators.SearchGroupsIterable responses = client.searchGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaSearchGroupsRequest.builder()
- Parameters:
searchGroupsRequest
- AConsumer
that will call methods onSearchGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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 aDescribeAssetBundleExportJob
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:
-
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 aDescribeAssetBundleExportJob
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 viaStartAssetBundleExportJobRequest.builder()
- Parameters:
startAssetBundleExportJobRequest
- AConsumer
that will call methods onStartAssetBundleExportJobRequest.Builder
to create a request.- Returns:
- Result of the StartAssetBundleExportJob operation returned by the service.
- See Also:
-
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:
-
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 viaStartAssetBundleImportJobRequest.builder()
- Parameters:
startAssetBundleImportJobRequest
- AConsumer
that will call methods onStartAssetBundleImportJobRequest.Builder
to create a request.- Returns:
- Result of the StartAssetBundleImportJob operation returned by the service.
- See Also:
-
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 snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.
-
1 Paginated PDF
-
1 Excel workbook that includes up to 5 table or pivot table visuals
-
5 CSVs from table or pivot table visuals
The status of a submitted job can be polled with the
DescribeDashboardSnapshotJob
API. When you call theDescribeDashboardSnapshotJob
API, check theJobStatus
field in the response. Once the job reaches aCOMPLETED
orFAILED
status, use theDescribeDashboardSnapshotJobResult
API to obtain the URLs for the generated files. If the job fails, theDescribeDashboardSnapshotJobResult
API returns detailed information about the error that occurred.StartDashboardSnapshotJob API throttling
Amazon QuickSight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the
StartDashboardSnapshotJob
. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Amazon QuickSight throttles the API calls to maintin an optimal experience and reliability for all Amazon QuickSight users.Common throttling scenarios
The following list provides information about the most commin throttling scenarios that can occur.
-
A large number of
SnapshotExport
API jobs are running simultaneously on an Amazon Web Services account. When a newStartDashboardSnapshotJob
is created and there are already 12 jobs with theRUNNING
status, the new job request fails and returns aLimitExceededException
error. Wait for a current job to comlpete before you resubmit the new job. -
A large number of API requests are submitted on an Amazon Web Services account. When a user makes more than 10 API calls to the Amazon QuickSight API in one second, a
ThrottlingException
is returned.
If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account.
Best practices to handle throttling
If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Amazon QuickSight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example
(12 minutes * 9 = 108 minutes)
. Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline.The time that it takes to process a job can be impacted by the following factors:
-
The dataset type (Direct Query or SPICE).
-
The size of the dataset.
-
The complexity of the calculated fields that are used in the dashboard.
-
The number of visuals that are on a sheet.
-
The types of visuals that are on the sheet.
-
The number of formats and snapshots that are requested in the job configuration.
-
The size of the generated snapshots.
- Parameters:
startDashboardSnapshotJobRequest
-- Returns:
- Result of the StartDashboardSnapshotJob operation returned by the service.
- See Also:
-
-
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 snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.
-
1 Paginated PDF
-
1 Excel workbook that includes up to 5 table or pivot table visuals
-
5 CSVs from table or pivot table visuals
The status of a submitted job can be polled with the
DescribeDashboardSnapshotJob
API. When you call theDescribeDashboardSnapshotJob
API, check theJobStatus
field in the response. Once the job reaches aCOMPLETED
orFAILED
status, use theDescribeDashboardSnapshotJobResult
API to obtain the URLs for the generated files. If the job fails, theDescribeDashboardSnapshotJobResult
API returns detailed information about the error that occurred.StartDashboardSnapshotJob API throttling
Amazon QuickSight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the
StartDashboardSnapshotJob
. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Amazon QuickSight throttles the API calls to maintin an optimal experience and reliability for all Amazon QuickSight users.Common throttling scenarios
The following list provides information about the most commin throttling scenarios that can occur.
-
A large number of
SnapshotExport
API jobs are running simultaneously on an Amazon Web Services account. When a newStartDashboardSnapshotJob
is created and there are already 12 jobs with theRUNNING
status, the new job request fails and returns aLimitExceededException
error. Wait for a current job to comlpete before you resubmit the new job. -
A large number of API requests are submitted on an Amazon Web Services account. When a user makes more than 10 API calls to the Amazon QuickSight API in one second, a
ThrottlingException
is returned.
If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account.
Best practices to handle throttling
If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Amazon QuickSight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example
(12 minutes * 9 = 108 minutes)
. Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline.The time that it takes to process a job can be impacted by the following factors:
-
The dataset type (Direct Query or SPICE).
-
The size of the dataset.
-
The complexity of the calculated fields that are used in the dashboard.
-
The number of visuals that are on a sheet.
-
The types of visuals that are on the sheet.
-
The number of formats and snapshots that are requested in the job configuration.
-
The size of the generated snapshots.
This is a convenience which creates an instance of the
StartDashboardSnapshotJobRequest.Builder
avoiding the need to create one manually viaStartDashboardSnapshotJobRequest.builder()
- Parameters:
startDashboardSnapshotJobRequest
- AConsumer
that will call methods onStartDashboardSnapshotJobRequest.Builder
to create a request.- Returns:
- Result of the StartDashboardSnapshotJob operation returned by the service.
- See Also:
-
-
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:
-
-
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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
-
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:
-
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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
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:
-
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 viaUpdateAccountCustomizationRequest.builder()
- Parameters:
updateAccountCustomizationRequest
- AConsumer
that will call methods onUpdateAccountCustomizationRequest.Builder
to create a request.- Returns:
- Result of the UpdateAccountCustomization operation returned by the service.
- See Also:
-
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:
-
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 viaUpdateAccountSettingsRequest.builder()
- Parameters:
updateAccountSettingsRequest
- AConsumer
that will call methods onUpdateAccountSettingsRequest.Builder
to create a request.- Returns:
- Result of the UpdateAccountSettings operation returned by the service.
- See Also:
-
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:
-
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 viaUpdateAnalysisRequest.builder()
- Parameters:
updateAnalysisRequest
- AConsumer
that will call methods onUpdateAnalysisRequest.Builder
to create a request.- Returns:
- Result of the UpdateAnalysis operation returned by the service.
- See Also:
-
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:
-
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 viaUpdateAnalysisPermissionsRequest.builder()
- Parameters:
updateAnalysisPermissionsRequest
- AConsumer
that will call methods onUpdateAnalysisPermissionsRequest.Builder
to create a request.- Returns:
- Result of the UpdateAnalysisPermissions operation returned by the service.
- See Also:
-
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:
-
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 viaUpdateDashboardRequest.builder()
- Parameters:
updateDashboardRequest
- AConsumer
that will call methods onUpdateDashboardRequest.Builder
to create a request.- Returns:
- Result of the UpdateDashboard operation returned by the service.
- See Also:
-
updateDashboardLinks
default UpdateDashboardLinksResponse updateDashboardLinks(UpdateDashboardLinksRequest updateDashboardLinksRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, ConflictException, AccessDeniedException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException Updates the linked analyses on a dashboard.
- Parameters:
updateDashboardLinksRequest
-- Returns:
- Result of the UpdateDashboardLinks operation returned by the service.
- See Also:
-
updateDashboardLinks
default UpdateDashboardLinksResponse updateDashboardLinks(Consumer<UpdateDashboardLinksRequest.Builder> updateDashboardLinksRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, ConflictException, AccessDeniedException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException Updates the linked analyses on a dashboard.
This is a convenience which creates an instance of the
UpdateDashboardLinksRequest.Builder
avoiding the need to create one manually viaUpdateDashboardLinksRequest.builder()
- Parameters:
updateDashboardLinksRequest
- AConsumer
that will call methods onUpdateDashboardLinksRequest.Builder
to create a request.- Returns:
- Result of the UpdateDashboardLinks operation returned by the service.
- See Also:
-
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:
-
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 viaUpdateDashboardPermissionsRequest.builder()
- Parameters:
updateDashboardPermissionsRequest
- AConsumer
that will call methods onUpdateDashboardPermissionsRequest.Builder
to create a request.- Returns:
- Result of the UpdateDashboardPermissions operation returned by the service.
- See Also:
-
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:
-
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 viaUpdateDashboardPublishedVersionRequest.builder()
- Parameters:
updateDashboardPublishedVersionRequest
- AConsumer
that will call methods onUpdateDashboardPublishedVersionRequest.Builder
to create a request.- Returns:
- Result of the UpdateDashboardPublishedVersion operation returned by the service.
- See Also:
-
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:
-
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 viaUpdateDataSetRequest.builder()
- Parameters:
updateDataSetRequest
- AConsumer
that will call methods onUpdateDataSetRequest.Builder
to create a request.- Returns:
- Result of the UpdateDataSet operation returned by the service.
- See Also:
-
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:
-
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 viaUpdateDataSetPermissionsRequest.builder()
- Parameters:
updateDataSetPermissionsRequest
- AConsumer
that will call methods onUpdateDataSetPermissionsRequest.Builder
to create a request.- Returns:
- Result of the UpdateDataSetPermissions operation returned by the service.
- See Also:
-
updateDataSource
default UpdateDataSourceResponse updateDataSource(UpdateDataSourceRequest updateDataSourceRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, CustomerManagedKeyUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException Updates a data source.
- Parameters:
updateDataSourceRequest
-- Returns:
- Result of the UpdateDataSource operation returned by the service.
- See Also:
-
updateDataSource
default UpdateDataSourceResponse updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, CustomerManagedKeyUnavailableException, 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 viaUpdateDataSourceRequest.builder()
- Parameters:
updateDataSourceRequest
- AConsumer
that will call methods onUpdateDataSourceRequest.Builder
to create a request.- Returns:
- Result of the UpdateDataSource operation returned by the service.
- See Also:
-
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:
-
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 viaUpdateDataSourcePermissionsRequest.builder()
- Parameters:
updateDataSourcePermissionsRequest
- AConsumer
that will call methods onUpdateDataSourcePermissionsRequest.Builder
to create a request.- Returns:
- Result of the UpdateDataSourcePermissions operation returned by the service.
- See Also:
-
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:
-
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 viaUpdateFolderRequest.builder()
- Parameters:
updateFolderRequest
- AConsumer
that will call methods onUpdateFolderRequest.Builder
to create a request.- Returns:
- Result of the UpdateFolder operation returned by the service.
- See Also:
-
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:
-
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 viaUpdateFolderPermissionsRequest.builder()
- Parameters:
updateFolderPermissionsRequest
- AConsumer
that will call methods onUpdateFolderPermissionsRequest.Builder
to create a request.- Returns:
- Result of the UpdateFolderPermissions operation returned by the service.
- See Also:
-
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:
-
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 viaUpdateGroupRequest.builder()
- Parameters:
updateGroupRequest
- AConsumer
that will call methods onUpdateGroupRequest.Builder
to create a request.- Returns:
- Result of the UpdateGroup operation returned by the service.
- See Also:
-
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:
-
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 viaUpdateIamPolicyAssignmentRequest.builder()
- Parameters:
updateIamPolicyAssignmentRequest
- AConsumer
that will call methods onUpdateIamPolicyAssignmentRequest.Builder
to create a request.- Returns:
- Result of the UpdateIAMPolicyAssignment operation returned by the service.
- See Also:
-
updateIdentityPropagationConfig
default UpdateIdentityPropagationConfigResponse updateIdentityPropagationConfig(UpdateIdentityPropagationConfigRequest updateIdentityPropagationConfigRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access.
This operation is only supported for Amazon QuickSight accounts using IAM Identity Center
- Parameters:
updateIdentityPropagationConfigRequest
-- Returns:
- Result of the UpdateIdentityPropagationConfig operation returned by the service.
- See Also:
-
updateIdentityPropagationConfig
default UpdateIdentityPropagationConfigResponse updateIdentityPropagationConfig(Consumer<UpdateIdentityPropagationConfigRequest.Builder> updateIdentityPropagationConfigRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access.
This operation is only supported for Amazon QuickSight accounts using IAM Identity Center
This is a convenience which creates an instance of the
UpdateIdentityPropagationConfigRequest.Builder
avoiding the need to create one manually viaUpdateIdentityPropagationConfigRequest.builder()
- Parameters:
updateIdentityPropagationConfigRequest
- AConsumer
that will call methods onUpdateIdentityPropagationConfigRequest.Builder
to create a request.- Returns:
- Result of the UpdateIdentityPropagationConfig operation returned by the service.
- See Also:
-
updateIpRestriction
default UpdateIpRestrictionResponse updateIpRestriction(UpdateIpRestrictionRequest updateIpRestrictionRequest) throws LimitExceededException, AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the
IpRestrictionRule
,VpcIdRestrictionRule
, orVpcEndpointIdRestrictionRule
. To use this operation, you must provide the entire map of rules. You can use theDescribeIpRestriction
operation to get the current rule map.- Parameters:
updateIpRestrictionRequest
-- Returns:
- Result of the UpdateIpRestriction operation returned by the service.
- See Also:
-
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. Traffic from a source is allowed when the source satisfies either the
IpRestrictionRule
,VpcIdRestrictionRule
, orVpcEndpointIdRestrictionRule
. To use this operation, you must provide the entire map of rules. You can use theDescribeIpRestriction
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 viaUpdateIpRestrictionRequest.builder()
- Parameters:
updateIpRestrictionRequest
- AConsumer
that will call methods onUpdateIpRestrictionRequest.Builder
to create a request.- Returns:
- Result of the UpdateIpRestriction operation returned by the service.
- See Also:
-
updateKeyRegistration
default UpdateKeyRegistrationResponse updateKeyRegistration(UpdateKeyRegistrationRequest updateKeyRegistrationRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException Updates a customer managed key in a Amazon QuickSight account.
- Parameters:
updateKeyRegistrationRequest
-- Returns:
- Result of the UpdateKeyRegistration operation returned by the service.
- See Also:
-
updateKeyRegistration
default UpdateKeyRegistrationResponse updateKeyRegistration(Consumer<UpdateKeyRegistrationRequest.Builder> updateKeyRegistrationRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException Updates a customer managed key in a Amazon QuickSight account.
This is a convenience which creates an instance of the
UpdateKeyRegistrationRequest.Builder
avoiding the need to create one manually viaUpdateKeyRegistrationRequest.builder()
- Parameters:
updateKeyRegistrationRequest
- AConsumer
that will call methods onUpdateKeyRegistrationRequest.Builder
to create a request.- Returns:
- Result of the UpdateKeyRegistration operation returned by the service.
- See Also:
-
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:
-
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 viaUpdatePublicSharingSettingsRequest.builder()
- Parameters:
updatePublicSharingSettingsRequest
- AConsumer
that will call methods onUpdatePublicSharingSettingsRequest.Builder
to create a request.- Returns:
- Result of the UpdatePublicSharingSettings operation returned by the service.
- See Also:
-
updateQPersonalizationConfiguration
default UpdateQPersonalizationConfigurationResponse updateQPersonalizationConfiguration(UpdateQPersonalizationConfigurationRequest updateQPersonalizationConfigurationRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException Updates a personalization configuration.
- Parameters:
updateQPersonalizationConfigurationRequest
-- Returns:
- Result of the UpdateQPersonalizationConfiguration operation returned by the service.
- See Also:
-
updateQPersonalizationConfiguration
default UpdateQPersonalizationConfigurationResponse updateQPersonalizationConfiguration(Consumer<UpdateQPersonalizationConfigurationRequest.Builder> updateQPersonalizationConfigurationRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException Updates a personalization configuration.
This is a convenience which creates an instance of the
UpdateQPersonalizationConfigurationRequest.Builder
avoiding the need to create one manually viaUpdateQPersonalizationConfigurationRequest.builder()
- Parameters:
updateQPersonalizationConfigurationRequest
- AConsumer
that will call methods onUpdateQPersonalizationConfigurationRequest.Builder
to create a request.- Returns:
- Result of the UpdateQPersonalizationConfiguration operation returned by the service.
- See Also:
-
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:
-
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 viaUpdateRefreshScheduleRequest.builder()
- Parameters:
updateRefreshScheduleRequest
- AConsumer
that will call methods onUpdateRefreshScheduleRequest.Builder
to create a request.- Returns:
- Result of the UpdateRefreshSchedule operation returned by the service.
- See Also:
-
updateRoleCustomPermission
default UpdateRoleCustomPermissionResponse updateRoleCustomPermission(UpdateRoleCustomPermissionRequest updateRoleCustomPermissionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException Updates the custom permissions that are associated with a role.
- Parameters:
updateRoleCustomPermissionRequest
-- Returns:
- Result of the UpdateRoleCustomPermission operation returned by the service.
- See Also:
-
updateRoleCustomPermission
default UpdateRoleCustomPermissionResponse updateRoleCustomPermission(Consumer<UpdateRoleCustomPermissionRequest.Builder> updateRoleCustomPermissionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException Updates the custom permissions that are associated with a role.
This is a convenience which creates an instance of the
UpdateRoleCustomPermissionRequest.Builder
avoiding the need to create one manually viaUpdateRoleCustomPermissionRequest.builder()
- Parameters:
updateRoleCustomPermissionRequest
- AConsumer
that will call methods onUpdateRoleCustomPermissionRequest.Builder
to create a request.- Returns:
- Result of the UpdateRoleCustomPermission operation returned by the service.
- See Also:
-
updateSPICECapacityConfiguration
default UpdateSpiceCapacityConfigurationResponse updateSPICECapacityConfiguration(UpdateSpiceCapacityConfigurationRequest updateSpiceCapacityConfigurationRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException Updates the SPICE capacity configuration for a Amazon QuickSight account.
- Parameters:
updateSpiceCapacityConfigurationRequest
-- Returns:
- Result of the UpdateSPICECapacityConfiguration operation returned by the service.
- See Also:
-
updateSPICECapacityConfiguration
default UpdateSpiceCapacityConfigurationResponse updateSPICECapacityConfiguration(Consumer<UpdateSpiceCapacityConfigurationRequest.Builder> updateSpiceCapacityConfigurationRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException Updates the SPICE capacity configuration for a Amazon QuickSight account.
This is a convenience which creates an instance of the
UpdateSpiceCapacityConfigurationRequest.Builder
avoiding the need to create one manually viaUpdateSpiceCapacityConfigurationRequest.builder()
- Parameters:
updateSpiceCapacityConfigurationRequest
- AConsumer
that will call methods onUpdateSpiceCapacityConfigurationRequest.Builder
to create a request.- Returns:
- Result of the UpdateSPICECapacityConfiguration operation returned by the service.
- See Also:
-
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:
-
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 viaUpdateTemplateRequest.builder()
- Parameters:
updateTemplateRequest
- AConsumer
that will call methods onUpdateTemplateRequest.Builder
to create a request.- Returns:
- Result of the UpdateTemplate operation returned by the service.
- See Also:
-
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:
-
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 viaUpdateTemplateAliasRequest.builder()
- Parameters:
updateTemplateAliasRequest
- AConsumer
that will call methods onUpdateTemplateAliasRequest.Builder
to create a request.- Returns:
- Result of the UpdateTemplateAlias operation returned by the service.
- See Also:
-
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:
-
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 viaUpdateTemplatePermissionsRequest.builder()
- Parameters:
updateTemplatePermissionsRequest
- AConsumer
that will call methods onUpdateTemplatePermissionsRequest.Builder
to create a request.- Returns:
- Result of the UpdateTemplatePermissions operation returned by the service.
- See Also:
-
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:
-
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 viaUpdateThemeRequest.builder()
- Parameters:
updateThemeRequest
- AConsumer
that will call methods onUpdateThemeRequest.Builder
to create a request.- Returns:
- Result of the UpdateTheme operation returned by the service.
- See Also:
-
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:
-
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 viaUpdateThemeAliasRequest.builder()
- Parameters:
updateThemeAliasRequest
- AConsumer
that will call methods onUpdateThemeAliasRequest.Builder
to create a request.- Returns:
- Result of the UpdateThemeAlias operation returned by the service.
- See Also:
-
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:
-
-
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 viaUpdateThemePermissionsRequest.builder()
- Parameters:
updateThemePermissionsRequest
- AConsumer
that will call methods onUpdateThemePermissionsRequest.Builder
to create a request.- Returns:
- Result of the UpdateThemePermissions operation returned by the service.
- See Also:
-
-
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:
-
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 viaUpdateTopicRequest.builder()
- Parameters:
updateTopicRequest
- AConsumer
that will call methods onUpdateTopicRequest.Builder
to create a request.- Returns:
- Result of the UpdateTopic operation returned by the service.
- See Also:
-
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:
-
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 viaUpdateTopicPermissionsRequest.builder()
- Parameters:
updateTopicPermissionsRequest
- AConsumer
that will call methods onUpdateTopicPermissionsRequest.Builder
to create a request.- Returns:
- Result of the UpdateTopicPermissions operation returned by the service.
- See Also:
-
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:
-
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 viaUpdateTopicRefreshScheduleRequest.builder()
- Parameters:
updateTopicRefreshScheduleRequest
- AConsumer
that will call methods onUpdateTopicRefreshScheduleRequest.Builder
to create a request.- Returns:
- Result of the UpdateTopicRefreshSchedule operation returned by the service.
- See Also:
-
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:
-
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 viaUpdateUserRequest.builder()
- Parameters:
updateUserRequest
- AConsumer
that will call methods onUpdateUserRequest.Builder
to create a request.- Returns:
- Result of the UpdateUser operation returned by the service.
- See Also:
-
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:
-
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 viaUpdateVpcConnectionRequest.builder()
- Parameters:
updateVpcConnectionRequest
- AConsumer
that will call methods onUpdateVpcConnectionRequest.Builder
to create a request.- Returns:
- Result of the UpdateVPCConnection operation returned by the service.
- See Also:
-
create
Create aQuickSightClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aQuickSightClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-