Interface QuickSightAsyncClient
-
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface QuickSightAsyncClient extends AwsClient
Service client for accessing Amazon QuickSight asynchronously. This can be created using the staticbuilder()
method.The asynchronous client performs non-blocking I/O when configured with anySdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.Amazon QuickSight API Reference Amazon QuickSight is a fully managed, serverless business intelligence service for the Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.
-
-
Field Summary
Fields Modifier and Type Field Description static String
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.static String
SERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
- Constant Field Values
-
-
Method Detail
-
cancelIngestion
default CompletableFuture<CancelIngestionResponse> cancelIngestion(CancelIngestionRequest cancelIngestionRequest)
Cancels an ongoing ingestion of data into SPICE.
- Parameters:
cancelIngestionRequest
-- Returns:
- A Java Future containing the result of the CancelIngestion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
cancelIngestion
default CompletableFuture<CancelIngestionResponse> cancelIngestion(Consumer<CancelIngestionRequest.Builder> cancelIngestionRequest)
Cancels an ongoing ingestion of data into SPICE.
This is a convenience which creates an instance of the
CancelIngestionRequest.Builder
avoiding the need to create one manually viaCancelIngestionRequest.builder()
- Parameters:
cancelIngestionRequest
- AConsumer
that will call methods onCancelIngestionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelIngestion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createAccountCustomization
default CompletableFuture<CreateAccountCustomizationResponse> createAccountCustomization(CreateAccountCustomizationRequest createAccountCustomizationRequest)
Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the
CreateAccountCustomization
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:
- A Java Future containing the result of the CreateAccountCustomization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createAccountCustomization
default CompletableFuture<CreateAccountCustomizationResponse> createAccountCustomization(Consumer<CreateAccountCustomizationRequest.Builder> createAccountCustomizationRequest)
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:
- A Java Future containing the result of the CreateAccountCustomization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createAccountSubscription
default CompletableFuture<CreateAccountSubscriptionResponse> createAccountSubscription(CreateAccountSubscriptionRequest createAccountSubscriptionRequest)
Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.
The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK.
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:
- A Java Future containing the result of the CreateAccountSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- PreconditionNotMetException One or more preconditions aren't met.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createAccountSubscription
default CompletableFuture<CreateAccountSubscriptionResponse> createAccountSubscription(Consumer<CreateAccountSubscriptionRequest.Builder> createAccountSubscriptionRequest)
Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.
The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK.
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:
- A Java Future containing the result of the CreateAccountSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- PreconditionNotMetException One or more preconditions aren't met.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createAnalysis
default CompletableFuture<CreateAnalysisResponse> createAnalysis(CreateAnalysisRequest createAnalysisRequest)
Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an
AnalysisDefinition
.- Parameters:
createAnalysisRequest
-- Returns:
- A Java Future containing the result of the CreateAnalysis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createAnalysis
default CompletableFuture<CreateAnalysisResponse> createAnalysis(Consumer<CreateAnalysisRequest.Builder> createAnalysisRequest)
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:
- A Java Future containing the result of the CreateAnalysis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createDashboard
default CompletableFuture<CreateDashboardResponse> createDashboard(CreateDashboardRequest createDashboardRequest)
Creates a dashboard from either a template or directly with a
DashboardDefinition
. To first create a template, see 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:
- A Java Future containing the result of the CreateDashboard operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createDashboard
default CompletableFuture<CreateDashboardResponse> createDashboard(Consumer<CreateDashboardRequest.Builder> createDashboardRequest)
Creates a dashboard from either a template or directly with a
DashboardDefinition
. To first create a template, see 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:
- A Java Future containing the result of the CreateDashboard operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createDataSet
default CompletableFuture<CreateDataSetResponse> createDataSet(CreateDataSetRequest createDataSetRequest)
Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
- Parameters:
createDataSetRequest
-- Returns:
- A Java Future containing the result of the CreateDataSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createDataSet
default CompletableFuture<CreateDataSetResponse> createDataSet(Consumer<CreateDataSetRequest.Builder> createDataSetRequest)
Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
This is a convenience which creates an instance of the
CreateDataSetRequest.Builder
avoiding the need to create one manually viaCreateDataSetRequest.builder()
- Parameters:
createDataSetRequest
- AConsumer
that will call methods onCreateDataSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDataSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createDataSource
default CompletableFuture<CreateDataSourceResponse> createDataSource(CreateDataSourceRequest createDataSourceRequest)
Creates a data source.
- Parameters:
createDataSourceRequest
-- Returns:
- A Java Future containing the result of the CreateDataSource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createDataSource
default CompletableFuture<CreateDataSourceResponse> createDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest)
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:
- A Java Future containing the result of the CreateDataSource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createFolder
default CompletableFuture<CreateFolderResponse> createFolder(CreateFolderRequest createFolderRequest)
Creates an empty shared folder.
- Parameters:
createFolderRequest
-- Returns:
- A Java Future containing the result of the CreateFolder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createFolder
default CompletableFuture<CreateFolderResponse> createFolder(Consumer<CreateFolderRequest.Builder> createFolderRequest)
Creates an empty shared folder.
This is a convenience which creates an instance of the
CreateFolderRequest.Builder
avoiding the need to create one manually viaCreateFolderRequest.builder()
- Parameters:
createFolderRequest
- AConsumer
that will call methods onCreateFolderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateFolder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createFolderMembership
default CompletableFuture<CreateFolderMembershipResponse> createFolderMembership(CreateFolderMembershipRequest createFolderMembershipRequest)
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
- Parameters:
createFolderMembershipRequest
-- Returns:
- A Java Future containing the result of the CreateFolderMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createFolderMembership
default CompletableFuture<CreateFolderMembershipResponse> createFolderMembership(Consumer<CreateFolderMembershipRequest.Builder> createFolderMembershipRequest)
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
This is a convenience which creates an instance of the
CreateFolderMembershipRequest.Builder
avoiding the need to create one manually viaCreateFolderMembershipRequest.builder()
- Parameters:
createFolderMembershipRequest
- AConsumer
that will call methods onCreateFolderMembershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateFolderMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createGroup
default CompletableFuture<CreateGroupResponse> createGroup(CreateGroupRequest createGroupRequest)
Use the
CreateGroup
operation to create a group in Amazon QuickSight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact Amazon Web Services Support.The permissions resource is
arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name>
.The response is a group object.
- Parameters:
createGroupRequest
- The request object for this operation.- Returns:
- A Java Future containing the result of the CreateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createGroup
default CompletableFuture<CreateGroupResponse> createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
Use the
CreateGroup
operation to create a group in Amazon QuickSight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact 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:
- A Java Future containing the result of the CreateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createGroupMembership
default CompletableFuture<CreateGroupMembershipResponse> createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest)
Adds an Amazon QuickSight user to an Amazon QuickSight group.
- Parameters:
createGroupMembershipRequest
-- Returns:
- A Java Future containing the result of the CreateGroupMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createGroupMembership
default CompletableFuture<CreateGroupMembershipResponse> createGroupMembership(Consumer<CreateGroupMembershipRequest.Builder> createGroupMembershipRequest)
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:
- A Java Future containing the result of the CreateGroupMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createIAMPolicyAssignment
default CompletableFuture<CreateIamPolicyAssignmentResponse> createIAMPolicyAssignment(CreateIamPolicyAssignmentRequest createIamPolicyAssignmentRequest)
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon 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:
- A Java Future containing the result of the CreateIAMPolicyAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConcurrentUpdatingException A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createIAMPolicyAssignment
default CompletableFuture<CreateIamPolicyAssignmentResponse> createIAMPolicyAssignment(Consumer<CreateIamPolicyAssignmentRequest.Builder> createIamPolicyAssignmentRequest)
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon 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:
- A Java Future containing the result of the CreateIAMPolicyAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConcurrentUpdatingException A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createIngestion
default CompletableFuture<CreateIngestionResponse> createIngestion(CreateIngestionRequest createIngestionRequest)
Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time.
Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
- Parameters:
createIngestionRequest
-- Returns:
- A Java Future containing the result of the CreateIngestion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createIngestion
default CompletableFuture<CreateIngestionResponse> createIngestion(Consumer<CreateIngestionRequest.Builder> createIngestionRequest)
Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time.
Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
This is a convenience which creates an instance of the
CreateIngestionRequest.Builder
avoiding the need to create one manually viaCreateIngestionRequest.builder()
- Parameters:
createIngestionRequest
- AConsumer
that will call methods onCreateIngestionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateIngestion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createNamespace
default CompletableFuture<CreateNamespaceResponse> createNamespace(CreateNamespaceRequest createNamespaceRequest)
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
A namespace allows you to isolate the Amazon QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.
- Parameters:
createNamespaceRequest
-- Returns:
- A Java Future containing the result of the CreateNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- PreconditionNotMetException One or more preconditions aren't met.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createNamespace
default CompletableFuture<CreateNamespaceResponse> createNamespace(Consumer<CreateNamespaceRequest.Builder> createNamespaceRequest)
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
A namespace allows you to isolate the Amazon QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.
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:
- A Java Future containing the result of the CreateNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- PreconditionNotMetException One or more preconditions aren't met.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createRefreshSchedule
default CompletableFuture<CreateRefreshScheduleResponse> createRefreshSchedule(CreateRefreshScheduleRequest createRefreshScheduleRequest)
Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
- Parameters:
createRefreshScheduleRequest
-- Returns:
- A Java Future containing the result of the CreateRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createRefreshSchedule
default CompletableFuture<CreateRefreshScheduleResponse> createRefreshSchedule(Consumer<CreateRefreshScheduleRequest.Builder> createRefreshScheduleRequest)
Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
This is a convenience which creates an instance of the
CreateRefreshScheduleRequest.Builder
avoiding the need to create one manually viaCreateRefreshScheduleRequest.builder()
- Parameters:
createRefreshScheduleRequest
- AConsumer
that will call methods onCreateRefreshScheduleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createRoleMembership
default CompletableFuture<CreateRoleMembershipResponse> createRoleMembership(CreateRoleMembershipRequest createRoleMembershipRequest)
Use
CreateRoleMembership
to add an existing Amazon QuickSight group to an existing role.- Parameters:
createRoleMembershipRequest
-- Returns:
- A Java Future containing the result of the CreateRoleMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createRoleMembership
default CompletableFuture<CreateRoleMembershipResponse> createRoleMembership(Consumer<CreateRoleMembershipRequest.Builder> createRoleMembershipRequest)
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:
- A Java Future containing the result of the CreateRoleMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createTemplate
default CompletableFuture<CreateTemplateResponse> createTemplate(CreateTemplateRequest createTemplateRequest)
Creates a template either from a
TemplateDefinition
or from an existing Amazon QuickSight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
- Parameters:
createTemplateRequest
-- Returns:
- A Java Future containing the result of the CreateTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createTemplate
default CompletableFuture<CreateTemplateResponse> createTemplate(Consumer<CreateTemplateRequest.Builder> createTemplateRequest)
Creates a template either from a
TemplateDefinition
or from an existing Amazon QuickSight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
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:
- A Java Future containing the result of the CreateTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createTemplateAlias
default CompletableFuture<CreateTemplateAliasResponse> createTemplateAlias(CreateTemplateAliasRequest createTemplateAliasRequest)
Creates a template alias for a template.
- Parameters:
createTemplateAliasRequest
-- Returns:
- A Java Future containing the result of the CreateTemplateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceExistsException The resource specified already exists.
- LimitExceededException A limit is exceeded.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createTemplateAlias
default CompletableFuture<CreateTemplateAliasResponse> createTemplateAlias(Consumer<CreateTemplateAliasRequest.Builder> createTemplateAliasRequest)
Creates a template alias for a template.
This is a convenience which creates an instance of the
CreateTemplateAliasRequest.Builder
avoiding the need to create one manually viaCreateTemplateAliasRequest.builder()
- Parameters:
createTemplateAliasRequest
- AConsumer
that will call methods onCreateTemplateAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateTemplateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceExistsException The resource specified already exists.
- LimitExceededException A limit is exceeded.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createTheme
default CompletableFuture<CreateThemeResponse> createTheme(CreateThemeRequest createThemeRequest)
Creates a theme.
A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.
- Parameters:
createThemeRequest
-- Returns:
- A Java Future containing the result of the CreateTheme operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createTheme
default CompletableFuture<CreateThemeResponse> createTheme(Consumer<CreateThemeRequest.Builder> createThemeRequest)
Creates a theme.
A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon 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:
- A Java Future containing the result of the CreateTheme operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createThemeAlias
default CompletableFuture<CreateThemeAliasResponse> createThemeAlias(CreateThemeAliasRequest createThemeAliasRequest)
Creates a theme alias for a theme.
- Parameters:
createThemeAliasRequest
-- Returns:
- A Java Future containing the result of the CreateThemeAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createThemeAlias
default CompletableFuture<CreateThemeAliasResponse> createThemeAlias(Consumer<CreateThemeAliasRequest.Builder> createThemeAliasRequest)
Creates a theme alias for a theme.
This is a convenience which creates an instance of the
CreateThemeAliasRequest.Builder
avoiding the need to create one manually viaCreateThemeAliasRequest.builder()
- Parameters:
createThemeAliasRequest
- AConsumer
that will call methods onCreateThemeAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateThemeAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createTopic
default CompletableFuture<CreateTopicResponse> createTopic(CreateTopicRequest createTopicRequest)
Creates a new Q topic.
- Parameters:
createTopicRequest
-- Returns:
- A Java Future containing the result of the CreateTopic operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createTopic
default CompletableFuture<CreateTopicResponse> createTopic(Consumer<CreateTopicRequest.Builder> createTopicRequest)
Creates a new Q topic.
This is a convenience which creates an instance of the
CreateTopicRequest.Builder
avoiding the need to create one manually viaCreateTopicRequest.builder()
- Parameters:
createTopicRequest
- AConsumer
that will call methods onCreateTopicRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateTopic operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createTopicRefreshSchedule
default CompletableFuture<CreateTopicRefreshScheduleResponse> createTopicRefreshSchedule(CreateTopicRefreshScheduleRequest createTopicRefreshScheduleRequest)
Creates a topic refresh schedule.
- Parameters:
createTopicRefreshScheduleRequest
-- Returns:
- A Java Future containing the result of the CreateTopicRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createTopicRefreshSchedule
default CompletableFuture<CreateTopicRefreshScheduleResponse> createTopicRefreshSchedule(Consumer<CreateTopicRefreshScheduleRequest.Builder> createTopicRefreshScheduleRequest)
Creates a topic refresh schedule.
This is a convenience which creates an instance of the
CreateTopicRefreshScheduleRequest.Builder
avoiding the need to create one manually viaCreateTopicRefreshScheduleRequest.builder()
- Parameters:
createTopicRefreshScheduleRequest
- AConsumer
that will call methods onCreateTopicRefreshScheduleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateTopicRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createVPCConnection
default CompletableFuture<CreateVpcConnectionResponse> createVPCConnection(CreateVpcConnectionRequest createVpcConnectionRequest)
Creates a new VPC connection.
- Parameters:
createVpcConnectionRequest
-- Returns:
- A Java Future containing the result of the CreateVPCConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createVPCConnection
default CompletableFuture<CreateVpcConnectionResponse> createVPCConnection(Consumer<CreateVpcConnectionRequest.Builder> createVpcConnectionRequest)
Creates a new VPC connection.
This is a convenience which creates an instance of the
CreateVpcConnectionRequest.Builder
avoiding the need to create one manually viaCreateVpcConnectionRequest.builder()
- Parameters:
createVpcConnectionRequest
- AConsumer
that will call methods onCreateVpcConnectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateVPCConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteAccountCustomization
default CompletableFuture<DeleteAccountCustomizationResponse> deleteAccountCustomization(DeleteAccountCustomizationRequest deleteAccountCustomizationRequest)
Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.
- Parameters:
deleteAccountCustomizationRequest
-- Returns:
- A Java Future containing the result of the DeleteAccountCustomization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteAccountCustomization
default CompletableFuture<DeleteAccountCustomizationResponse> deleteAccountCustomization(Consumer<DeleteAccountCustomizationRequest.Builder> deleteAccountCustomizationRequest)
Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.
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:
- A Java Future containing the result of the DeleteAccountCustomization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteAccountSubscription
default CompletableFuture<DeleteAccountSubscriptionResponse> deleteAccountSubscription(DeleteAccountSubscriptionRequest deleteAccountSubscriptionRequest)
Use the
DeleteAccountSubscription
operation to delete an Amazon QuickSight account. This operation will result in an error message if you have configured your account termination protection settings 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:
- A Java Future containing the result of the DeleteAccountSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteAccountSubscription
default CompletableFuture<DeleteAccountSubscriptionResponse> deleteAccountSubscription(Consumer<DeleteAccountSubscriptionRequest.Builder> deleteAccountSubscriptionRequest)
Use the
DeleteAccountSubscription
operation to delete an Amazon QuickSight account. This operation will result in an error message if you have configured your account termination protection settings 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:
- A Java Future containing the result of the DeleteAccountSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteAnalysis
default CompletableFuture<DeleteAnalysisResponse> deleteAnalysis(DeleteAnalysisRequest deleteAnalysisRequest)
Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon QuickSight attaches a
DeletionTime
stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon QuickSight deletes the analysis permanently.At any time before recovery window ends, you can use the
RestoreAnalysis
API operation to remove 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:
- A Java Future containing the result of the DeleteAnalysis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteAnalysis
default CompletableFuture<DeleteAnalysisResponse> deleteAnalysis(Consumer<DeleteAnalysisRequest.Builder> deleteAnalysisRequest)
Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon QuickSight attaches a
DeletionTime
stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon QuickSight deletes the analysis permanently.At any time before recovery window ends, you can use the
RestoreAnalysis
API operation to remove 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:
- A Java Future containing the result of the DeleteAnalysis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteDashboard
default CompletableFuture<DeleteDashboardResponse> deleteDashboard(DeleteDashboardRequest deleteDashboardRequest)
Deletes a dashboard.
- Parameters:
deleteDashboardRequest
-- Returns:
- A Java Future containing the result of the DeleteDashboard operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteDashboard
default CompletableFuture<DeleteDashboardResponse> deleteDashboard(Consumer<DeleteDashboardRequest.Builder> deleteDashboardRequest)
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:
- A Java Future containing the result of the DeleteDashboard operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteDataSet
default CompletableFuture<DeleteDataSetResponse> deleteDataSet(DeleteDataSetRequest deleteDataSetRequest)
Deletes a dataset.
- Parameters:
deleteDataSetRequest
-- Returns:
- A Java Future containing the result of the DeleteDataSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteDataSet
default CompletableFuture<DeleteDataSetResponse> deleteDataSet(Consumer<DeleteDataSetRequest.Builder> deleteDataSetRequest)
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:
- A Java Future containing the result of the DeleteDataSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteDataSetRefreshProperties
default CompletableFuture<DeleteDataSetRefreshPropertiesResponse> deleteDataSetRefreshProperties(DeleteDataSetRefreshPropertiesRequest deleteDataSetRefreshPropertiesRequest)
Deletes the dataset refresh properties of the dataset.
- Parameters:
deleteDataSetRefreshPropertiesRequest
-- Returns:
- A Java Future containing the result of the DeleteDataSetRefreshProperties operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteDataSetRefreshProperties
default CompletableFuture<DeleteDataSetRefreshPropertiesResponse> deleteDataSetRefreshProperties(Consumer<DeleteDataSetRefreshPropertiesRequest.Builder> deleteDataSetRefreshPropertiesRequest)
Deletes the dataset refresh properties of the dataset.
This is a convenience which creates an instance of the
DeleteDataSetRefreshPropertiesRequest.Builder
avoiding the need to create one manually viaDeleteDataSetRefreshPropertiesRequest.builder()
- Parameters:
deleteDataSetRefreshPropertiesRequest
- AConsumer
that will call methods onDeleteDataSetRefreshPropertiesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDataSetRefreshProperties operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteDataSource
default CompletableFuture<DeleteDataSourceResponse> deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)
Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
- Parameters:
deleteDataSourceRequest
-- Returns:
- A Java Future containing the result of the DeleteDataSource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteDataSource
default CompletableFuture<DeleteDataSourceResponse> deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest)
Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
This is a convenience which creates an instance of the
DeleteDataSourceRequest.Builder
avoiding the need to create one manually viaDeleteDataSourceRequest.builder()
- Parameters:
deleteDataSourceRequest
- AConsumer
that will call methods onDeleteDataSourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDataSource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteFolder
default CompletableFuture<DeleteFolderResponse> deleteFolder(DeleteFolderRequest deleteFolderRequest)
Deletes an empty folder.
- Parameters:
deleteFolderRequest
-- Returns:
- A Java Future containing the result of the DeleteFolder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- PreconditionNotMetException One or more preconditions aren't met.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteFolder
default CompletableFuture<DeleteFolderResponse> deleteFolder(Consumer<DeleteFolderRequest.Builder> deleteFolderRequest)
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:
- A Java Future containing the result of the DeleteFolder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- PreconditionNotMetException One or more preconditions aren't met.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteFolderMembership
default CompletableFuture<DeleteFolderMembershipResponse> deleteFolderMembership(DeleteFolderMembershipRequest deleteFolderMembershipRequest)
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
- Parameters:
deleteFolderMembershipRequest
-- Returns:
- A Java Future containing the result of the DeleteFolderMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteFolderMembership
default CompletableFuture<DeleteFolderMembershipResponse> deleteFolderMembership(Consumer<DeleteFolderMembershipRequest.Builder> deleteFolderMembershipRequest)
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
This is a convenience which creates an instance of the
DeleteFolderMembershipRequest.Builder
avoiding the need to create one manually viaDeleteFolderMembershipRequest.builder()
- Parameters:
deleteFolderMembershipRequest
- AConsumer
that will call methods onDeleteFolderMembershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteFolderMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteGroup
default CompletableFuture<DeleteGroupResponse> deleteGroup(DeleteGroupRequest deleteGroupRequest)
Removes a user group from Amazon QuickSight.
- Parameters:
deleteGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteGroup
default CompletableFuture<DeleteGroupResponse> deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)
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:
- A Java Future containing the result of the DeleteGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteGroupMembership
default CompletableFuture<DeleteGroupMembershipResponse> deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest)
Removes a user from a group so that the user is no longer a member of the group.
- Parameters:
deleteGroupMembershipRequest
-- Returns:
- A Java Future containing the result of the DeleteGroupMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteGroupMembership
default CompletableFuture<DeleteGroupMembershipResponse> deleteGroupMembership(Consumer<DeleteGroupMembershipRequest.Builder> deleteGroupMembershipRequest)
Removes a user from a group so that the user is no longer a member of the group.
This is a convenience which creates an instance of the
DeleteGroupMembershipRequest.Builder
avoiding the need to create one manually viaDeleteGroupMembershipRequest.builder()
- Parameters:
deleteGroupMembershipRequest
- AConsumer
that will call methods onDeleteGroupMembershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteGroupMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteIAMPolicyAssignment
default CompletableFuture<DeleteIamPolicyAssignmentResponse> deleteIAMPolicyAssignment(DeleteIamPolicyAssignmentRequest deleteIamPolicyAssignmentRequest)
Deletes an existing IAM policy assignment.
- Parameters:
deleteIamPolicyAssignmentRequest
-- Returns:
- A Java Future containing the result of the DeleteIAMPolicyAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConcurrentUpdatingException A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteIAMPolicyAssignment
default CompletableFuture<DeleteIamPolicyAssignmentResponse> deleteIAMPolicyAssignment(Consumer<DeleteIamPolicyAssignmentRequest.Builder> deleteIamPolicyAssignmentRequest)
Deletes an existing IAM policy assignment.
This is a convenience which creates an instance of the
DeleteIamPolicyAssignmentRequest.Builder
avoiding the need to create one manually viaDeleteIamPolicyAssignmentRequest.builder()
- Parameters:
deleteIamPolicyAssignmentRequest
- AConsumer
that will call methods onDeleteIamPolicyAssignmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteIAMPolicyAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConcurrentUpdatingException A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteIdentityPropagationConfig
default CompletableFuture<DeleteIdentityPropagationConfigResponse> deleteIdentityPropagationConfig(DeleteIdentityPropagationConfigRequest deleteIdentityPropagationConfigRequest)
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:
- A Java Future containing the result of the DeleteIdentityPropagationConfig operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteIdentityPropagationConfig
default CompletableFuture<DeleteIdentityPropagationConfigResponse> 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.
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:
- A Java Future containing the result of the DeleteIdentityPropagationConfig operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteNamespace
default CompletableFuture<DeleteNamespaceResponse> deleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest)
Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.
- Parameters:
deleteNamespaceRequest
-- Returns:
- A Java Future containing the result of the DeleteNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteNamespace
default CompletableFuture<DeleteNamespaceResponse> deleteNamespace(Consumer<DeleteNamespaceRequest.Builder> deleteNamespaceRequest)
Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.
This is a convenience which creates an instance of the
DeleteNamespaceRequest.Builder
avoiding the need to create one manually viaDeleteNamespaceRequest.builder()
- Parameters:
deleteNamespaceRequest
- AConsumer
that will call methods onDeleteNamespaceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteRefreshSchedule
default CompletableFuture<DeleteRefreshScheduleResponse> deleteRefreshSchedule(DeleteRefreshScheduleRequest deleteRefreshScheduleRequest)
Deletes a refresh schedule from a dataset.
- Parameters:
deleteRefreshScheduleRequest
-- Returns:
- A Java Future containing the result of the DeleteRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteRefreshSchedule
default CompletableFuture<DeleteRefreshScheduleResponse> deleteRefreshSchedule(Consumer<DeleteRefreshScheduleRequest.Builder> deleteRefreshScheduleRequest)
Deletes a refresh schedule from a dataset.
This is a convenience which creates an instance of the
DeleteRefreshScheduleRequest.Builder
avoiding the need to create one manually viaDeleteRefreshScheduleRequest.builder()
- Parameters:
deleteRefreshScheduleRequest
- AConsumer
that will call methods onDeleteRefreshScheduleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteRoleCustomPermission
default CompletableFuture<DeleteRoleCustomPermissionResponse> deleteRoleCustomPermission(DeleteRoleCustomPermissionRequest deleteRoleCustomPermissionRequest)
Removes custom permissions from the role.
- Parameters:
deleteRoleCustomPermissionRequest
-- Returns:
- A Java Future containing the result of the DeleteRoleCustomPermission operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteRoleCustomPermission
default CompletableFuture<DeleteRoleCustomPermissionResponse> deleteRoleCustomPermission(Consumer<DeleteRoleCustomPermissionRequest.Builder> deleteRoleCustomPermissionRequest)
Removes custom permissions from the role.
This is a convenience which creates an instance of the
DeleteRoleCustomPermissionRequest.Builder
avoiding the need to create one manually viaDeleteRoleCustomPermissionRequest.builder()
- Parameters:
deleteRoleCustomPermissionRequest
- AConsumer
that will call methods onDeleteRoleCustomPermissionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRoleCustomPermission operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteRoleMembership
default CompletableFuture<DeleteRoleMembershipResponse> deleteRoleMembership(DeleteRoleMembershipRequest deleteRoleMembershipRequest)
Removes a group from a role.
- Parameters:
deleteRoleMembershipRequest
-- Returns:
- A Java Future containing the result of the DeleteRoleMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteRoleMembership
default CompletableFuture<DeleteRoleMembershipResponse> deleteRoleMembership(Consumer<DeleteRoleMembershipRequest.Builder> deleteRoleMembershipRequest)
Removes a group from a role.
This is a convenience which creates an instance of the
DeleteRoleMembershipRequest.Builder
avoiding the need to create one manually viaDeleteRoleMembershipRequest.builder()
- Parameters:
deleteRoleMembershipRequest
- AConsumer
that will call methods onDeleteRoleMembershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRoleMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteTemplate
default CompletableFuture<DeleteTemplateResponse> deleteTemplate(DeleteTemplateRequest deleteTemplateRequest)
Deletes a template.
- Parameters:
deleteTemplateRequest
-- Returns:
- A Java Future containing the result of the DeleteTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- LimitExceededException A limit is exceeded.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteTemplate
default CompletableFuture<DeleteTemplateResponse> deleteTemplate(Consumer<DeleteTemplateRequest.Builder> deleteTemplateRequest)
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:
- A Java Future containing the result of the DeleteTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- LimitExceededException A limit is exceeded.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteTemplateAlias
default CompletableFuture<DeleteTemplateAliasResponse> deleteTemplateAlias(DeleteTemplateAliasRequest deleteTemplateAliasRequest)
Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
- Parameters:
deleteTemplateAliasRequest
-- Returns:
- A Java Future containing the result of the DeleteTemplateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteTemplateAlias
default CompletableFuture<DeleteTemplateAliasResponse> deleteTemplateAlias(Consumer<DeleteTemplateAliasRequest.Builder> deleteTemplateAliasRequest)
Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
This is a convenience which creates an instance of the
DeleteTemplateAliasRequest.Builder
avoiding the need to create one manually viaDeleteTemplateAliasRequest.builder()
- Parameters:
deleteTemplateAliasRequest
- AConsumer
that will call methods onDeleteTemplateAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteTemplateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteTheme
default CompletableFuture<DeleteThemeResponse> deleteTheme(DeleteThemeRequest deleteThemeRequest)
Deletes a theme.
- Parameters:
deleteThemeRequest
-- Returns:
- A Java Future containing the result of the DeleteTheme operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteTheme
default CompletableFuture<DeleteThemeResponse> deleteTheme(Consumer<DeleteThemeRequest.Builder> deleteThemeRequest)
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:
- A Java Future containing the result of the DeleteTheme operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteThemeAlias
default CompletableFuture<DeleteThemeAliasResponse> deleteThemeAlias(DeleteThemeAliasRequest deleteThemeAliasRequest)
Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.
- Parameters:
deleteThemeAliasRequest
-- Returns:
- A Java Future containing the result of the DeleteThemeAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteThemeAlias
default CompletableFuture<DeleteThemeAliasResponse> deleteThemeAlias(Consumer<DeleteThemeAliasRequest.Builder> deleteThemeAliasRequest)
Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.
This is a convenience which creates an instance of the
DeleteThemeAliasRequest.Builder
avoiding the need to create one manually viaDeleteThemeAliasRequest.builder()
- Parameters:
deleteThemeAliasRequest
- AConsumer
that will call methods onDeleteThemeAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteThemeAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteTopic
default CompletableFuture<DeleteTopicResponse> deleteTopic(DeleteTopicRequest deleteTopicRequest)
Deletes a topic.
- Parameters:
deleteTopicRequest
-- Returns:
- A Java Future containing the result of the DeleteTopic operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteTopic
default CompletableFuture<DeleteTopicResponse> deleteTopic(Consumer<DeleteTopicRequest.Builder> deleteTopicRequest)
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:
- A Java Future containing the result of the DeleteTopic operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteTopicRefreshSchedule
default CompletableFuture<DeleteTopicRefreshScheduleResponse> deleteTopicRefreshSchedule(DeleteTopicRefreshScheduleRequest deleteTopicRefreshScheduleRequest)
Deletes a topic refresh schedule.
- Parameters:
deleteTopicRefreshScheduleRequest
-- Returns:
- A Java Future containing the result of the DeleteTopicRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteTopicRefreshSchedule
default CompletableFuture<DeleteTopicRefreshScheduleResponse> deleteTopicRefreshSchedule(Consumer<DeleteTopicRefreshScheduleRequest.Builder> deleteTopicRefreshScheduleRequest)
Deletes a topic refresh schedule.
This is a convenience which creates an instance of the
DeleteTopicRefreshScheduleRequest.Builder
avoiding the need to create one manually viaDeleteTopicRefreshScheduleRequest.builder()
- Parameters:
deleteTopicRefreshScheduleRequest
- AConsumer
that will call methods onDeleteTopicRefreshScheduleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteTopicRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteUser
default CompletableFuture<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. The IAM user isn't deleted as a result of this call.
- Parameters:
deleteUserRequest
-- Returns:
- A Java Future containing the result of the DeleteUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteUser
default CompletableFuture<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. 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:
- A Java Future containing the result of the DeleteUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteUserByPrincipalId
default CompletableFuture<DeleteUserByPrincipalIdResponse> deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest deleteUserByPrincipalIdRequest)
Deletes a user identified by its principal ID.
- Parameters:
deleteUserByPrincipalIdRequest
-- Returns:
- A Java Future containing the result of the DeleteUserByPrincipalId operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteUserByPrincipalId
default CompletableFuture<DeleteUserByPrincipalIdResponse> deleteUserByPrincipalId(Consumer<DeleteUserByPrincipalIdRequest.Builder> deleteUserByPrincipalIdRequest)
Deletes a user identified by its principal ID.
This is a convenience which creates an instance of the
DeleteUserByPrincipalIdRequest.Builder
avoiding the need to create one manually viaDeleteUserByPrincipalIdRequest.builder()
- Parameters:
deleteUserByPrincipalIdRequest
- AConsumer
that will call methods onDeleteUserByPrincipalIdRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteUserByPrincipalId operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteVPCConnection
default CompletableFuture<DeleteVpcConnectionResponse> deleteVPCConnection(DeleteVpcConnectionRequest deleteVpcConnectionRequest)
Deletes a VPC connection.
- Parameters:
deleteVpcConnectionRequest
-- Returns:
- A Java Future containing the result of the DeleteVPCConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteVPCConnection
default CompletableFuture<DeleteVpcConnectionResponse> deleteVPCConnection(Consumer<DeleteVpcConnectionRequest.Builder> deleteVpcConnectionRequest)
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:
- A Java Future containing the result of the DeleteVPCConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeAccountCustomization
default CompletableFuture<DescribeAccountCustomizationResponse> describeAccountCustomization(DescribeAccountCustomizationRequest describeAccountCustomizationRequest)
Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region. 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:
- A Java Future containing the result of the DescribeAccountCustomization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
describeAccountCustomization
default CompletableFuture<DescribeAccountCustomizationResponse> describeAccountCustomization(Consumer<DescribeAccountCustomizationRequest.Builder> describeAccountCustomizationRequest)
Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region. 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:
- A Java Future containing the result of the DescribeAccountCustomization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
describeAccountSettings
default CompletableFuture<DescribeAccountSettingsResponse> describeAccountSettings(DescribeAccountSettingsRequest describeAccountSettingsRequest)
Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
- Parameters:
describeAccountSettingsRequest
-- Returns:
- A Java Future containing the result of the DescribeAccountSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeAccountSettings
default CompletableFuture<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.
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:
- A Java Future containing the result of the DescribeAccountSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeAccountSubscription
default CompletableFuture<DescribeAccountSubscriptionResponse> describeAccountSubscription(DescribeAccountSubscriptionRequest describeAccountSubscriptionRequest)
Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription. A successful API call returns an
AccountInfo
object that includes an account's name, subscription status, authentication type, edition, and notification email address.- Parameters:
describeAccountSubscriptionRequest
-- Returns:
- A Java Future containing the result of the DescribeAccountSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeAccountSubscription
default CompletableFuture<DescribeAccountSubscriptionResponse> describeAccountSubscription(Consumer<DescribeAccountSubscriptionRequest.Builder> describeAccountSubscriptionRequest)
Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription. A successful API call returns an
AccountInfo
object that includes an account's name, subscription status, authentication type, edition, and notification email address.
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:
- A Java Future containing the result of the DescribeAccountSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeAnalysis
default CompletableFuture<DescribeAnalysisResponse> describeAnalysis(DescribeAnalysisRequest describeAnalysisRequest)
Provides a summary of the metadata for an analysis.
- Parameters:
describeAnalysisRequest
-- Returns:
- A Java Future containing the result of the DescribeAnalysis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeAnalysis
default CompletableFuture<DescribeAnalysisResponse> describeAnalysis(Consumer<DescribeAnalysisRequest.Builder> describeAnalysisRequest)
Provides a summary of the metadata for an analysis.
This is a convenience which creates an instance of the
DescribeAnalysisRequest.Builder
avoiding the need to create one manually viaDescribeAnalysisRequest.builder()
- Parameters:
describeAnalysisRequest
- AConsumer
that will call methods onDescribeAnalysisRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAnalysis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeAnalysisDefinition
default CompletableFuture<DescribeAnalysisDefinitionResponse> describeAnalysisDefinition(DescribeAnalysisDefinitionRequest describeAnalysisDefinitionRequest)
Provides a detailed description of the definition of an analysis.
If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the
DescribeAnalysis
instead.- Parameters:
describeAnalysisDefinitionRequest
-- Returns:
- A Java Future containing the result of the DescribeAnalysisDefinition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeAnalysisDefinition
default CompletableFuture<DescribeAnalysisDefinitionResponse> describeAnalysisDefinition(Consumer<DescribeAnalysisDefinitionRequest.Builder> describeAnalysisDefinitionRequest)
Provides a detailed description of the definition of an analysis.
If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the
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:
- A Java Future containing the result of the DescribeAnalysisDefinition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeAnalysisPermissions
default CompletableFuture<DescribeAnalysisPermissionsResponse> describeAnalysisPermissions(DescribeAnalysisPermissionsRequest describeAnalysisPermissionsRequest)
Provides the read and write permissions for an analysis.
- Parameters:
describeAnalysisPermissionsRequest
-- Returns:
- A Java Future containing the result of the DescribeAnalysisPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeAnalysisPermissions
default CompletableFuture<DescribeAnalysisPermissionsResponse> describeAnalysisPermissions(Consumer<DescribeAnalysisPermissionsRequest.Builder> describeAnalysisPermissionsRequest)
Provides the read and write permissions for an analysis.
This is a convenience which creates an instance of the
DescribeAnalysisPermissionsRequest.Builder
avoiding the need to create one manually viaDescribeAnalysisPermissionsRequest.builder()
- Parameters:
describeAnalysisPermissionsRequest
- AConsumer
that will call methods onDescribeAnalysisPermissionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAnalysisPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeAssetBundleExportJob
default CompletableFuture<DescribeAssetBundleExportJobResponse> describeAssetBundleExportJob(DescribeAssetBundleExportJobRequest describeAssetBundleExportJobRequest)
Describes an existing export job.
Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the
DescribeAssetBundleExportJob
API for a new download URL as needed.Job descriptions are available for 14 days after the job starts.
- Parameters:
describeAssetBundleExportJobRequest
-- Returns:
- A Java Future containing the result of the DescribeAssetBundleExportJob operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeAssetBundleExportJob
default CompletableFuture<DescribeAssetBundleExportJobResponse> describeAssetBundleExportJob(Consumer<DescribeAssetBundleExportJobRequest.Builder> describeAssetBundleExportJobRequest)
Describes an existing export job.
Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the
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:
- A Java Future containing the result of the DescribeAssetBundleExportJob operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeAssetBundleImportJob
default CompletableFuture<DescribeAssetBundleImportJobResponse> describeAssetBundleImportJob(DescribeAssetBundleImportJobRequest describeAssetBundleImportJobRequest)
Describes an existing import job.
Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.
- Parameters:
describeAssetBundleImportJobRequest
-- Returns:
- A Java Future containing the result of the DescribeAssetBundleImportJob operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeAssetBundleImportJob
default CompletableFuture<DescribeAssetBundleImportJobResponse> describeAssetBundleImportJob(Consumer<DescribeAssetBundleImportJobRequest.Builder> describeAssetBundleImportJobRequest)
Describes an existing import job.
Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.
This is a convenience which creates an instance of the
DescribeAssetBundleImportJobRequest.Builder
avoiding the need to create one manually viaDescribeAssetBundleImportJobRequest.builder()
- Parameters:
describeAssetBundleImportJobRequest
- AConsumer
that will call methods onDescribeAssetBundleImportJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAssetBundleImportJob operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeDashboard
default CompletableFuture<DescribeDashboardResponse> describeDashboard(DescribeDashboardRequest describeDashboardRequest)
Provides a summary for a dashboard.
- Parameters:
describeDashboardRequest
-- Returns:
- A Java Future containing the result of the DescribeDashboard operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeDashboard
default CompletableFuture<DescribeDashboardResponse> describeDashboard(Consumer<DescribeDashboardRequest.Builder> describeDashboardRequest)
Provides a summary for a dashboard.
This is a convenience which creates an instance of the
DescribeDashboardRequest.Builder
avoiding the need to create one manually viaDescribeDashboardRequest.builder()
- Parameters:
describeDashboardRequest
- AConsumer
that will call methods onDescribeDashboardRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDashboard operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeDashboardDefinition
default CompletableFuture<DescribeDashboardDefinitionResponse> describeDashboardDefinition(DescribeDashboardDefinitionRequest describeDashboardDefinitionRequest)
Provides a detailed description of the definition of a dashboard.
If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the
DescribeDashboard
instead.- Parameters:
describeDashboardDefinitionRequest
-- Returns:
- A Java Future containing the result of the DescribeDashboardDefinition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeDashboardDefinition
default CompletableFuture<DescribeDashboardDefinitionResponse> describeDashboardDefinition(Consumer<DescribeDashboardDefinitionRequest.Builder> describeDashboardDefinitionRequest)
Provides a detailed description of the definition of a dashboard.
If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the
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:
- A Java Future containing the result of the DescribeDashboardDefinition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeDashboardPermissions
default CompletableFuture<DescribeDashboardPermissionsResponse> describeDashboardPermissions(DescribeDashboardPermissionsRequest describeDashboardPermissionsRequest)
Describes read and write permissions for a dashboard.
- Parameters:
describeDashboardPermissionsRequest
-- Returns:
- A Java Future containing the result of the DescribeDashboardPermissions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeDashboardPermissions
default CompletableFuture<DescribeDashboardPermissionsResponse> describeDashboardPermissions(Consumer<DescribeDashboardPermissionsRequest.Builder> describeDashboardPermissionsRequest)
Describes read and write permissions for a dashboard.
This is a convenience which creates an instance of the
DescribeDashboardPermissionsRequest.Builder
avoiding the need to create one manually viaDescribeDashboardPermissionsRequest.builder()
- Parameters:
describeDashboardPermissionsRequest
- AConsumer
that will call methods onDescribeDashboardPermissionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDashboardPermissions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeDashboardSnapshotJob
default CompletableFuture<DescribeDashboardSnapshotJobResponse> describeDashboardSnapshotJob(DescribeDashboardSnapshotJobRequest describeDashboardSnapshotJobRequest)
Describes an existing snapshot job.
Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see
JobStatus
.- Parameters:
describeDashboardSnapshotJobRequest
-- Returns:
- A Java Future containing the result of the DescribeDashboardSnapshotJob operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeDashboardSnapshotJob
default CompletableFuture<DescribeDashboardSnapshotJobResponse> describeDashboardSnapshotJob(Consumer<DescribeDashboardSnapshotJobRequest.Builder> describeDashboardSnapshotJobRequest)
Describes an existing snapshot job.
Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see
JobStatus
.
This is a convenience which creates an instance of the
DescribeDashboardSnapshotJobRequest.Builder
avoiding the need to create one manually viaDescribeDashboardSnapshotJobRequest.builder()
- Parameters:
describeDashboardSnapshotJobRequest
- AConsumer
that will call methods onDescribeDashboardSnapshotJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDashboardSnapshotJob operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeDashboardSnapshotJobResult
default CompletableFuture<DescribeDashboardSnapshotJobResultResponse> describeDashboardSnapshotJobResult(DescribeDashboardSnapshotJobResultRequest describeDashboardSnapshotJobResultRequest)
Describes the result of an existing snapshot job that has finished running.
A finished snapshot job will return a
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:
- A Java Future containing the result of the DescribeDashboardSnapshotJobResult operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeDashboardSnapshotJobResult
default CompletableFuture<DescribeDashboardSnapshotJobResultResponse> describeDashboardSnapshotJobResult(Consumer<DescribeDashboardSnapshotJobResultRequest.Builder> describeDashboardSnapshotJobResultRequest)
Describes the result of an existing snapshot job that has finished running.
A finished snapshot job will return a
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:
- A Java Future containing the result of the DescribeDashboardSnapshotJobResult operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeDataSet
default CompletableFuture<DescribeDataSetResponse> describeDataSet(DescribeDataSetRequest describeDataSetRequest)
Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.
- Parameters:
describeDataSetRequest
-- Returns:
- A Java Future containing the result of the DescribeDataSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeDataSet
default CompletableFuture<DescribeDataSetResponse> describeDataSet(Consumer<DescribeDataSetRequest.Builder> describeDataSetRequest)
Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.
This is a convenience which creates an instance of the
DescribeDataSetRequest.Builder
avoiding the need to create one manually viaDescribeDataSetRequest.builder()
- Parameters:
describeDataSetRequest
- AConsumer
that will call methods onDescribeDataSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDataSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeDataSetPermissions
default CompletableFuture<DescribeDataSetPermissionsResponse> describeDataSetPermissions(DescribeDataSetPermissionsRequest describeDataSetPermissionsRequest)
Describes the permissions on a dataset.
The permissions resource is
arn:aws:quicksight:region:aws-account-id:dataset/data-set-id
.- Parameters:
describeDataSetPermissionsRequest
-- Returns:
- A Java Future containing the result of the DescribeDataSetPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeDataSetPermissions
default CompletableFuture<DescribeDataSetPermissionsResponse> describeDataSetPermissions(Consumer<DescribeDataSetPermissionsRequest.Builder> describeDataSetPermissionsRequest)
Describes the permissions on a dataset.
The permissions resource is
arn:aws:quicksight:region:aws-account-id:dataset/data-set-id
.
This is a convenience which creates an instance of the
DescribeDataSetPermissionsRequest.Builder
avoiding the need to create one manually viaDescribeDataSetPermissionsRequest.builder()
- Parameters:
describeDataSetPermissionsRequest
- AConsumer
that will call methods onDescribeDataSetPermissionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDataSetPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeDataSetRefreshProperties
default CompletableFuture<DescribeDataSetRefreshPropertiesResponse> describeDataSetRefreshProperties(DescribeDataSetRefreshPropertiesRequest describeDataSetRefreshPropertiesRequest)
Describes the refresh properties of a dataset.
- Parameters:
describeDataSetRefreshPropertiesRequest
-- Returns:
- A Java Future containing the result of the DescribeDataSetRefreshProperties operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeDataSetRefreshProperties
default CompletableFuture<DescribeDataSetRefreshPropertiesResponse> describeDataSetRefreshProperties(Consumer<DescribeDataSetRefreshPropertiesRequest.Builder> describeDataSetRefreshPropertiesRequest)
Describes the refresh properties of a dataset.
This is a convenience which creates an instance of the
DescribeDataSetRefreshPropertiesRequest.Builder
avoiding the need to create one manually viaDescribeDataSetRefreshPropertiesRequest.builder()
- Parameters:
describeDataSetRefreshPropertiesRequest
- AConsumer
that will call methods onDescribeDataSetRefreshPropertiesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDataSetRefreshProperties operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeDataSource
default CompletableFuture<DescribeDataSourceResponse> describeDataSource(DescribeDataSourceRequest describeDataSourceRequest)
Describes a data source.
- Parameters:
describeDataSourceRequest
-- Returns:
- A Java Future containing the result of the DescribeDataSource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeDataSource
default CompletableFuture<DescribeDataSourceResponse> describeDataSource(Consumer<DescribeDataSourceRequest.Builder> describeDataSourceRequest)
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:
- A Java Future containing the result of the DescribeDataSource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeDataSourcePermissions
default CompletableFuture<DescribeDataSourcePermissionsResponse> describeDataSourcePermissions(DescribeDataSourcePermissionsRequest describeDataSourcePermissionsRequest)
Describes the resource permissions for a data source.
- Parameters:
describeDataSourcePermissionsRequest
-- Returns:
- A Java Future containing the result of the DescribeDataSourcePermissions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeDataSourcePermissions
default CompletableFuture<DescribeDataSourcePermissionsResponse> describeDataSourcePermissions(Consumer<DescribeDataSourcePermissionsRequest.Builder> describeDataSourcePermissionsRequest)
Describes the resource permissions for a data source.
This is a convenience which creates an instance of the
DescribeDataSourcePermissionsRequest.Builder
avoiding the need to create one manually viaDescribeDataSourcePermissionsRequest.builder()
- Parameters:
describeDataSourcePermissionsRequest
- AConsumer
that will call methods onDescribeDataSourcePermissionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDataSourcePermissions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeFolder
default CompletableFuture<DescribeFolderResponse> describeFolder(DescribeFolderRequest describeFolderRequest)
Describes a folder.
- Parameters:
describeFolderRequest
-- Returns:
- A Java Future containing the result of the DescribeFolder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeFolder
default CompletableFuture<DescribeFolderResponse> describeFolder(Consumer<DescribeFolderRequest.Builder> describeFolderRequest)
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:
- A Java Future containing the result of the DescribeFolder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeFolderPermissions
default CompletableFuture<DescribeFolderPermissionsResponse> describeFolderPermissions(DescribeFolderPermissionsRequest describeFolderPermissionsRequest)
Describes permissions for a folder.
- Parameters:
describeFolderPermissionsRequest
-- Returns:
- A Java Future containing the result of the DescribeFolderPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeFolderPermissions
default CompletableFuture<DescribeFolderPermissionsResponse> describeFolderPermissions(Consumer<DescribeFolderPermissionsRequest.Builder> describeFolderPermissionsRequest)
Describes permissions for a folder.
This is a convenience which creates an instance of the
DescribeFolderPermissionsRequest.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 Java Future containing the result of the DescribeFolderPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeFolderPermissionsPaginator
default DescribeFolderPermissionsPublisher describeFolderPermissionsPaginator(DescribeFolderPermissionsRequest describeFolderPermissionsRequest)
This is a variant of
describeFolderPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.DescribeFolderPermissionsPublisher publisher = client.describeFolderPermissionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.DescribeFolderPermissionsPublisher publisher = client.describeFolderPermissionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFolderPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsRequest)
operation.- Parameters:
describeFolderPermissionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeFolderPermissionsPaginator
default DescribeFolderPermissionsPublisher describeFolderPermissionsPaginator(Consumer<DescribeFolderPermissionsRequest.Builder> describeFolderPermissionsRequest)
This is a variant of
describeFolderPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.DescribeFolderPermissionsPublisher publisher = client.describeFolderPermissionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.DescribeFolderPermissionsPublisher publisher = client.describeFolderPermissionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFolderPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeFolderPermissionsRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeFolderResolvedPermissions
default CompletableFuture<DescribeFolderResolvedPermissionsResponse> describeFolderResolvedPermissions(DescribeFolderResolvedPermissionsRequest describeFolderResolvedPermissionsRequest)
Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
- Parameters:
describeFolderResolvedPermissionsRequest
-- Returns:
- A Java Future containing the result of the DescribeFolderResolvedPermissions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeFolderResolvedPermissions
default CompletableFuture<DescribeFolderResolvedPermissionsResponse> describeFolderResolvedPermissions(Consumer<DescribeFolderResolvedPermissionsRequest.Builder> describeFolderResolvedPermissionsRequest)
Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
This is a convenience which creates an instance of the
DescribeFolderResolvedPermissionsRequest.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 Java Future containing the result of the DescribeFolderResolvedPermissions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeFolderResolvedPermissionsPaginator
default DescribeFolderResolvedPermissionsPublisher describeFolderResolvedPermissionsPaginator(DescribeFolderResolvedPermissionsRequest describeFolderResolvedPermissionsRequest)
This is a variant of
describeFolderResolvedPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.DescribeFolderResolvedPermissionsPublisher publisher = client.describeFolderResolvedPermissionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.DescribeFolderResolvedPermissionsPublisher publisher = client.describeFolderResolvedPermissionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFolderResolvedPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsRequest)
operation.- Parameters:
describeFolderResolvedPermissionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeFolderResolvedPermissionsPaginator
default DescribeFolderResolvedPermissionsPublisher describeFolderResolvedPermissionsPaginator(Consumer<DescribeFolderResolvedPermissionsRequest.Builder> describeFolderResolvedPermissionsRequest)
This is a variant of
describeFolderResolvedPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.DescribeFolderResolvedPermissionsPublisher publisher = client.describeFolderResolvedPermissionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.DescribeFolderResolvedPermissionsPublisher publisher = client.describeFolderResolvedPermissionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFolderResolvedPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeFolderResolvedPermissionsRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeGroup
default CompletableFuture<DescribeGroupResponse> describeGroup(DescribeGroupRequest describeGroupRequest)
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
- Parameters:
describeGroupRequest
-- Returns:
- A Java Future containing the result of the DescribeGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeGroup
default CompletableFuture<DescribeGroupResponse> describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest)
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:
- A Java Future containing the result of the DescribeGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeGroupMembership
default CompletableFuture<DescribeGroupMembershipResponse> describeGroupMembership(DescribeGroupMembershipRequest describeGroupMembershipRequest)
Use the
DescribeGroupMembership
operation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associatedGroupMember
object is returned.- Parameters:
describeGroupMembershipRequest
-- Returns:
- A Java Future containing the result of the DescribeGroupMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeGroupMembership
default CompletableFuture<DescribeGroupMembershipResponse> describeGroupMembership(Consumer<DescribeGroupMembershipRequest.Builder> describeGroupMembershipRequest)
Use the
DescribeGroupMembership
operation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an 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:
- A Java Future containing the result of the DescribeGroupMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeIAMPolicyAssignment
default CompletableFuture<DescribeIamPolicyAssignmentResponse> describeIAMPolicyAssignment(DescribeIamPolicyAssignmentRequest describeIamPolicyAssignmentRequest)
Describes an existing IAM policy assignment, as specified by the assignment name.
- Parameters:
describeIamPolicyAssignmentRequest
-- Returns:
- A Java Future containing the result of the DescribeIAMPolicyAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeIAMPolicyAssignment
default CompletableFuture<DescribeIamPolicyAssignmentResponse> describeIAMPolicyAssignment(Consumer<DescribeIamPolicyAssignmentRequest.Builder> describeIamPolicyAssignmentRequest)
Describes an existing IAM policy assignment, as specified by the assignment name.
This is a convenience which creates an instance of the
DescribeIamPolicyAssignmentRequest.Builder
avoiding the need to create one manually viaDescribeIamPolicyAssignmentRequest.builder()
- Parameters:
describeIamPolicyAssignmentRequest
- AConsumer
that will call methods onDescribeIamPolicyAssignmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeIAMPolicyAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeIngestion
default CompletableFuture<DescribeIngestionResponse> describeIngestion(DescribeIngestionRequest describeIngestionRequest)
Describes a SPICE ingestion.
- Parameters:
describeIngestionRequest
-- Returns:
- A Java Future containing the result of the DescribeIngestion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeIngestion
default CompletableFuture<DescribeIngestionResponse> describeIngestion(Consumer<DescribeIngestionRequest.Builder> describeIngestionRequest)
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:
- A Java Future containing the result of the DescribeIngestion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeIpRestriction
default CompletableFuture<DescribeIpRestrictionResponse> describeIpRestriction(DescribeIpRestrictionRequest describeIpRestrictionRequest)
Provides a summary and status of IP rules.
- Parameters:
describeIpRestrictionRequest
-- Returns:
- A Java Future containing the result of the DescribeIpRestriction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeIpRestriction
default CompletableFuture<DescribeIpRestrictionResponse> describeIpRestriction(Consumer<DescribeIpRestrictionRequest.Builder> describeIpRestrictionRequest)
Provides a summary and status of IP rules.
This is a convenience which creates an instance of the
DescribeIpRestrictionRequest.Builder
avoiding the need to create one manually viaDescribeIpRestrictionRequest.builder()
- Parameters:
describeIpRestrictionRequest
- AConsumer
that will call methods onDescribeIpRestrictionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeIpRestriction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeKeyRegistration
default CompletableFuture<DescribeKeyRegistrationResponse> describeKeyRegistration(DescribeKeyRegistrationRequest describeKeyRegistrationRequest)
Describes all customer managed key registrations in a Amazon QuickSight account.
- Parameters:
describeKeyRegistrationRequest
-- Returns:
- A Java Future containing the result of the DescribeKeyRegistration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeKeyRegistration
default CompletableFuture<DescribeKeyRegistrationResponse> describeKeyRegistration(Consumer<DescribeKeyRegistrationRequest.Builder> describeKeyRegistrationRequest)
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:
- A Java Future containing the result of the DescribeKeyRegistration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeNamespace
default CompletableFuture<DescribeNamespaceResponse> describeNamespace(DescribeNamespaceRequest describeNamespaceRequest)
Describes the current namespace.
- Parameters:
describeNamespaceRequest
-- Returns:
- A Java Future containing the result of the DescribeNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeNamespace
default CompletableFuture<DescribeNamespaceResponse> describeNamespace(Consumer<DescribeNamespaceRequest.Builder> describeNamespaceRequest)
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:
- A Java Future containing the result of the DescribeNamespace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeRefreshSchedule
default CompletableFuture<DescribeRefreshScheduleResponse> describeRefreshSchedule(DescribeRefreshScheduleRequest describeRefreshScheduleRequest)
Provides a summary of a refresh schedule.
- Parameters:
describeRefreshScheduleRequest
-- Returns:
- A Java Future containing the result of the DescribeRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeRefreshSchedule
default CompletableFuture<DescribeRefreshScheduleResponse> describeRefreshSchedule(Consumer<DescribeRefreshScheduleRequest.Builder> describeRefreshScheduleRequest)
Provides a summary of a refresh schedule.
This is a convenience which creates an instance of the
DescribeRefreshScheduleRequest.Builder
avoiding the need to create one manually viaDescribeRefreshScheduleRequest.builder()
- Parameters:
describeRefreshScheduleRequest
- AConsumer
that will call methods onDescribeRefreshScheduleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeRoleCustomPermission
default CompletableFuture<DescribeRoleCustomPermissionResponse> describeRoleCustomPermission(DescribeRoleCustomPermissionRequest describeRoleCustomPermissionRequest)
Describes all custom permissions that are mapped to a role.
- Parameters:
describeRoleCustomPermissionRequest
-- Returns:
- A Java Future containing the result of the DescribeRoleCustomPermission operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeRoleCustomPermission
default CompletableFuture<DescribeRoleCustomPermissionResponse> describeRoleCustomPermission(Consumer<DescribeRoleCustomPermissionRequest.Builder> describeRoleCustomPermissionRequest)
Describes all custom permissions that are mapped to a role.
This is a convenience which creates an instance of the
DescribeRoleCustomPermissionRequest.Builder
avoiding the need to create one manually viaDescribeRoleCustomPermissionRequest.builder()
- Parameters:
describeRoleCustomPermissionRequest
- AConsumer
that will call methods onDescribeRoleCustomPermissionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeRoleCustomPermission operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeTemplate
default CompletableFuture<DescribeTemplateResponse> describeTemplate(DescribeTemplateRequest describeTemplateRequest)
Describes a template's metadata.
- Parameters:
describeTemplateRequest
-- Returns:
- A Java Future containing the result of the DescribeTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeTemplate
default CompletableFuture<DescribeTemplateResponse> describeTemplate(Consumer<DescribeTemplateRequest.Builder> describeTemplateRequest)
Describes a template's metadata.
This is a convenience which creates an instance of the
DescribeTemplateRequest.Builder
avoiding the need to create one manually viaDescribeTemplateRequest.builder()
- Parameters:
describeTemplateRequest
- AConsumer
that will call methods onDescribeTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeTemplateAlias
default CompletableFuture<DescribeTemplateAliasResponse> describeTemplateAlias(DescribeTemplateAliasRequest describeTemplateAliasRequest)
Describes the template alias for a template.
- Parameters:
describeTemplateAliasRequest
-- Returns:
- A Java Future containing the result of the DescribeTemplateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeTemplateAlias
default CompletableFuture<DescribeTemplateAliasResponse> describeTemplateAlias(Consumer<DescribeTemplateAliasRequest.Builder> describeTemplateAliasRequest)
Describes the template alias for a template.
This is a convenience which creates an instance of the
DescribeTemplateAliasRequest.Builder
avoiding the need to create one manually viaDescribeTemplateAliasRequest.builder()
- Parameters:
describeTemplateAliasRequest
- AConsumer
that will call methods onDescribeTemplateAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeTemplateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeTemplateDefinition
default CompletableFuture<DescribeTemplateDefinitionResponse> describeTemplateDefinition(DescribeTemplateDefinitionRequest describeTemplateDefinitionRequest)
Provides a detailed description of the definition of a template.
If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the
DescribeTemplate
instead.- Parameters:
describeTemplateDefinitionRequest
-- Returns:
- A Java Future containing the result of the DescribeTemplateDefinition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeTemplateDefinition
default CompletableFuture<DescribeTemplateDefinitionResponse> describeTemplateDefinition(Consumer<DescribeTemplateDefinitionRequest.Builder> describeTemplateDefinitionRequest)
Provides a detailed description of the definition of a template.
If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the
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:
- A Java Future containing the result of the DescribeTemplateDefinition operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeTemplatePermissions
default CompletableFuture<DescribeTemplatePermissionsResponse> describeTemplatePermissions(DescribeTemplatePermissionsRequest describeTemplatePermissionsRequest)
Describes read and write permissions on a template.
- Parameters:
describeTemplatePermissionsRequest
-- Returns:
- A Java Future containing the result of the DescribeTemplatePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeTemplatePermissions
default CompletableFuture<DescribeTemplatePermissionsResponse> describeTemplatePermissions(Consumer<DescribeTemplatePermissionsRequest.Builder> describeTemplatePermissionsRequest)
Describes read and write permissions on a template.
This is a convenience which creates an instance of the
DescribeTemplatePermissionsRequest.Builder
avoiding the need to create one manually viaDescribeTemplatePermissionsRequest.builder()
- Parameters:
describeTemplatePermissionsRequest
- AConsumer
that will call methods onDescribeTemplatePermissionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeTemplatePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeTheme
default CompletableFuture<DescribeThemeResponse> describeTheme(DescribeThemeRequest describeThemeRequest)
Describes a theme.
- Parameters:
describeThemeRequest
-- Returns:
- A Java Future containing the result of the DescribeTheme operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeTheme
default CompletableFuture<DescribeThemeResponse> describeTheme(Consumer<DescribeThemeRequest.Builder> describeThemeRequest)
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:
- A Java Future containing the result of the DescribeTheme operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeThemeAlias
default CompletableFuture<DescribeThemeAliasResponse> describeThemeAlias(DescribeThemeAliasRequest describeThemeAliasRequest)
Describes the alias for a theme.
- Parameters:
describeThemeAliasRequest
-- Returns:
- A Java Future containing the result of the DescribeThemeAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeThemeAlias
default CompletableFuture<DescribeThemeAliasResponse> describeThemeAlias(Consumer<DescribeThemeAliasRequest.Builder> describeThemeAliasRequest)
Describes the alias for a theme.
This is a convenience which creates an instance of the
DescribeThemeAliasRequest.Builder
avoiding the need to create one manually viaDescribeThemeAliasRequest.builder()
- Parameters:
describeThemeAliasRequest
- AConsumer
that will call methods onDescribeThemeAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeThemeAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeThemePermissions
default CompletableFuture<DescribeThemePermissionsResponse> describeThemePermissions(DescribeThemePermissionsRequest describeThemePermissionsRequest)
Describes the read and write permissions for a theme.
- Parameters:
describeThemePermissionsRequest
-- Returns:
- A Java Future containing the result of the DescribeThemePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeThemePermissions
default CompletableFuture<DescribeThemePermissionsResponse> describeThemePermissions(Consumer<DescribeThemePermissionsRequest.Builder> describeThemePermissionsRequest)
Describes the read and write permissions for a theme.
This is a convenience which creates an instance of the
DescribeThemePermissionsRequest.Builder
avoiding the need to create one manually viaDescribeThemePermissionsRequest.builder()
- Parameters:
describeThemePermissionsRequest
- AConsumer
that will call methods onDescribeThemePermissionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeThemePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeTopic
default CompletableFuture<DescribeTopicResponse> describeTopic(DescribeTopicRequest describeTopicRequest)
Describes a topic.
- Parameters:
describeTopicRequest
-- Returns:
- A Java Future containing the result of the DescribeTopic operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeTopic
default CompletableFuture<DescribeTopicResponse> describeTopic(Consumer<DescribeTopicRequest.Builder> describeTopicRequest)
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:
- A Java Future containing the result of the DescribeTopic operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeTopicPermissions
default CompletableFuture<DescribeTopicPermissionsResponse> describeTopicPermissions(DescribeTopicPermissionsRequest describeTopicPermissionsRequest)
Describes the permissions of a topic.
- Parameters:
describeTopicPermissionsRequest
-- Returns:
- A Java Future containing the result of the DescribeTopicPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeTopicPermissions
default CompletableFuture<DescribeTopicPermissionsResponse> describeTopicPermissions(Consumer<DescribeTopicPermissionsRequest.Builder> describeTopicPermissionsRequest)
Describes the permissions of a topic.
This is a convenience which creates an instance of the
DescribeTopicPermissionsRequest.Builder
avoiding the need to create one manually viaDescribeTopicPermissionsRequest.builder()
- Parameters:
describeTopicPermissionsRequest
- AConsumer
that will call methods onDescribeTopicPermissionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeTopicPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeTopicRefresh
default CompletableFuture<DescribeTopicRefreshResponse> describeTopicRefresh(DescribeTopicRefreshRequest describeTopicRefreshRequest)
Describes the status of a topic refresh.
- Parameters:
describeTopicRefreshRequest
-- Returns:
- A Java Future containing the result of the DescribeTopicRefresh operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeTopicRefresh
default CompletableFuture<DescribeTopicRefreshResponse> describeTopicRefresh(Consumer<DescribeTopicRefreshRequest.Builder> describeTopicRefreshRequest)
Describes the status of a topic refresh.
This is a convenience which creates an instance of the
DescribeTopicRefreshRequest.Builder
avoiding the need to create one manually viaDescribeTopicRefreshRequest.builder()
- Parameters:
describeTopicRefreshRequest
- AConsumer
that will call methods onDescribeTopicRefreshRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeTopicRefresh operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeTopicRefreshSchedule
default CompletableFuture<DescribeTopicRefreshScheduleResponse> describeTopicRefreshSchedule(DescribeTopicRefreshScheduleRequest describeTopicRefreshScheduleRequest)
Deletes a topic refresh schedule.
- Parameters:
describeTopicRefreshScheduleRequest
-- Returns:
- A Java Future containing the result of the DescribeTopicRefreshSchedule operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeTopicRefreshSchedule
default CompletableFuture<DescribeTopicRefreshScheduleResponse> describeTopicRefreshSchedule(Consumer<DescribeTopicRefreshScheduleRequest.Builder> describeTopicRefreshScheduleRequest)
Deletes a topic refresh schedule.
This is a convenience which creates an instance of the
DescribeTopicRefreshScheduleRequest.Builder
avoiding the need to create one manually viaDescribeTopicRefreshScheduleRequest.builder()
- Parameters:
describeTopicRefreshScheduleRequest
- AConsumer
that will call methods onDescribeTopicRefreshScheduleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeTopicRefreshSchedule operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeUser
default CompletableFuture<DescribeUserResponse> describeUser(DescribeUserRequest describeUserRequest)
Returns information about a user, given the user name.
- Parameters:
describeUserRequest
-- Returns:
- A Java Future containing the result of the DescribeUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeUser
default CompletableFuture<DescribeUserResponse> describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)
Returns information about a user, given the user name.
This is a convenience which creates an instance of the
DescribeUserRequest.Builder
avoiding the need to create one manually viaDescribeUserRequest.builder()
- Parameters:
describeUserRequest
- AConsumer
that will call methods onDescribeUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeVPCConnection
default CompletableFuture<DescribeVpcConnectionResponse> describeVPCConnection(DescribeVpcConnectionRequest describeVpcConnectionRequest)
Describes a VPC connection.
- Parameters:
describeVpcConnectionRequest
-- Returns:
- A Java Future containing the result of the DescribeVPCConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
describeVPCConnection
default CompletableFuture<DescribeVpcConnectionResponse> describeVPCConnection(Consumer<DescribeVpcConnectionRequest.Builder> describeVpcConnectionRequest)
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:
- A Java Future containing the result of the DescribeVPCConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
generateEmbedUrlForAnonymousUser
default CompletableFuture<GenerateEmbedUrlForAnonymousUserResponse> generateEmbedUrlForAnonymousUser(GenerateEmbedUrlForAnonymousUserRequest generateEmbedUrlForAnonymousUserRequest)
Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.
The following rules apply to the generated URL:
-
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
-
The URL validity period should not be confused with the actual session lifetime that can be customized using the
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:
- A Java Future containing the result of the GenerateEmbedUrlForAnonymousUser operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- SessionLifetimeInMinutesInvalidException The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be 15-600 minutes.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- UnsupportedPricingPlanException This error indicates that you are calling an embedding operation in
Amazon QuickSight without the required pricing plan on your Amazon Web Services account. Before you can
use embedding for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon
QuickSight. You can do this on the Manage Amazon QuickSight page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrl
API operation with the--identity-type ANONYMOUS
option. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
generateEmbedUrlForAnonymousUser
default CompletableFuture<GenerateEmbedUrlForAnonymousUserResponse> generateEmbedUrlForAnonymousUser(Consumer<GenerateEmbedUrlForAnonymousUserRequest.Builder> generateEmbedUrlForAnonymousUserRequest)
Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.
The following rules apply to the generated URL:
-
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
-
The URL validity period should not be confused with the actual session lifetime that can be customized using the
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:
- A Java Future containing the result of the GenerateEmbedUrlForAnonymousUser operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- SessionLifetimeInMinutesInvalidException The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be 15-600 minutes.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- UnsupportedPricingPlanException This error indicates that you are calling an embedding operation in
Amazon QuickSight without the required pricing plan on your Amazon Web Services account. Before you can
use embedding for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon
QuickSight. You can do this on the Manage Amazon QuickSight page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrl
API operation with the--identity-type ANONYMOUS
option. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
generateEmbedUrlForRegisteredUser
default CompletableFuture<GenerateEmbedUrlForRegisteredUserResponse> generateEmbedUrlForRegisteredUser(GenerateEmbedUrlForRegisteredUserRequest generateEmbedUrlForRegisteredUserRequest)
Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.
The following rules apply to the generated URL:
-
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
-
The URL validity period should not be confused with the actual session lifetime that can be customized using the
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:
- A Java Future containing the result of the GenerateEmbedUrlForRegisteredUser operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- QuickSightUserNotFoundException The user with the provided name isn't found. This error can happen in
any operation that requires finding a user based on a provided user name, such as
DeleteUser
,DescribeUser
, and so on. - ResourceNotFoundException One or more resources can't be found.
- SessionLifetimeInMinutesInvalidException The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be 15-600 minutes.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- UnsupportedPricingPlanException This error indicates that you are calling an embedding operation in
Amazon QuickSight without the required pricing plan on your Amazon Web Services account. Before you can
use embedding for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon
QuickSight. You can do this on the Manage Amazon QuickSight page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrl
API operation with the--identity-type ANONYMOUS
option. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
generateEmbedUrlForRegisteredUser
default CompletableFuture<GenerateEmbedUrlForRegisteredUserResponse> generateEmbedUrlForRegisteredUser(Consumer<GenerateEmbedUrlForRegisteredUserRequest.Builder> generateEmbedUrlForRegisteredUserRequest)
Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.
The following rules apply to the generated URL:
-
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
-
The URL validity period should not be confused with the actual session lifetime that can be customized using the
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:
- A Java Future containing the result of the GenerateEmbedUrlForRegisteredUser operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- QuickSightUserNotFoundException The user with the provided name isn't found. This error can happen in
any operation that requires finding a user based on a provided user name, such as
DeleteUser
,DescribeUser
, and so on. - ResourceNotFoundException One or more resources can't be found.
- SessionLifetimeInMinutesInvalidException The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be 15-600 minutes.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- UnsupportedPricingPlanException This error indicates that you are calling an embedding operation in
Amazon QuickSight without the required pricing plan on your Amazon Web Services account. Before you can
use embedding for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon
QuickSight. You can do this on the Manage Amazon QuickSight page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrl
API operation with the--identity-type ANONYMOUS
option. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
getDashboardEmbedUrl
default CompletableFuture<GetDashboardEmbedUrlResponse> getDashboardEmbedUrl(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest)
Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon 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:
- A Java Future containing the result of the GetDashboardEmbedUrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- DomainNotWhitelistedException The domain specified isn't on the allow list. All domains for embedded dashboards must be added to the approved list by an Amazon QuickSight admin.
- QuickSightUserNotFoundException The user with the provided name isn't found. This error can happen in
any operation that requires finding a user based on a provided user name, such as
DeleteUser
,DescribeUser
, and so on. - IdentityTypeNotSupportedException The identity type specified isn't supported. Supported identity
types include
IAM
andQUICKSIGHT
. - SessionLifetimeInMinutesInvalidException The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be 15-600 minutes.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- UnsupportedPricingPlanException This error indicates that you are calling an embedding operation in
Amazon QuickSight without the required pricing plan on your Amazon Web Services account. Before you can
use embedding for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon
QuickSight. You can do this on the Manage Amazon QuickSight page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrl
API operation with the--identity-type ANONYMOUS
option. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
getDashboardEmbedUrl
default CompletableFuture<GetDashboardEmbedUrlResponse> getDashboardEmbedUrl(Consumer<GetDashboardEmbedUrlRequest.Builder> getDashboardEmbedUrlRequest)
Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon 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:
- A Java Future containing the result of the GetDashboardEmbedUrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- DomainNotWhitelistedException The domain specified isn't on the allow list. All domains for embedded dashboards must be added to the approved list by an Amazon QuickSight admin.
- QuickSightUserNotFoundException The user with the provided name isn't found. This error can happen in
any operation that requires finding a user based on a provided user name, such as
DeleteUser
,DescribeUser
, and so on. - IdentityTypeNotSupportedException The identity type specified isn't supported. Supported identity
types include
IAM
andQUICKSIGHT
. - SessionLifetimeInMinutesInvalidException The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be 15-600 minutes.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- UnsupportedPricingPlanException This error indicates that you are calling an embedding operation in
Amazon QuickSight without the required pricing plan on your Amazon Web Services account. Before you can
use embedding for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon
QuickSight. You can do this on the Manage Amazon QuickSight page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrl
API operation with the--identity-type ANONYMOUS
option. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
getSessionEmbedUrl
default CompletableFuture<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. 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:
- A Java Future containing the result of the GetSessionEmbedUrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- QuickSightUserNotFoundException The user with the provided name isn't found. This error can happen in
any operation that requires finding a user based on a provided user name, such as
DeleteUser
,DescribeUser
, and so on. - SessionLifetimeInMinutesInvalidException The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be 15-600 minutes.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getSessionEmbedUrl
default CompletableFuture<GetSessionEmbedUrlResponse> getSessionEmbedUrl(Consumer<GetSessionEmbedUrlRequest.Builder> getSessionEmbedUrlRequest)
Generates a session URL and authorization code that you can use to embed the Amazon Amazon 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:
- A Java Future containing the result of the GetSessionEmbedUrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- QuickSightUserNotFoundException The user with the provided name isn't found. This error can happen in
any operation that requires finding a user based on a provided user name, such as
DeleteUser
,DescribeUser
, and so on. - SessionLifetimeInMinutesInvalidException The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be 15-600 minutes.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listAnalyses
default CompletableFuture<ListAnalysesResponse> listAnalyses(ListAnalysesRequest listAnalysesRequest)
Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
- Parameters:
listAnalysesRequest
-- Returns:
- A Java Future containing the result of the ListAnalyses operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listAnalyses
default CompletableFuture<ListAnalysesResponse> listAnalyses(Consumer<ListAnalysesRequest.Builder> listAnalysesRequest)
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:
- A Java Future containing the result of the ListAnalyses operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listAnalysesPaginator
default ListAnalysesPublisher listAnalysesPaginator(ListAnalysesRequest listAnalysesRequest)
This is a variant of
listAnalyses(software.amazon.awssdk.services.quicksight.model.ListAnalysesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListAnalysesPublisher publisher = client.listAnalysesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListAnalysesPublisher publisher = client.listAnalysesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListAnalysesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListAnalysesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAnalyses(software.amazon.awssdk.services.quicksight.model.ListAnalysesRequest)
operation.- Parameters:
listAnalysesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listAnalysesPaginator
default ListAnalysesPublisher listAnalysesPaginator(Consumer<ListAnalysesRequest.Builder> listAnalysesRequest)
This is a variant of
listAnalyses(software.amazon.awssdk.services.quicksight.model.ListAnalysesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListAnalysesPublisher publisher = client.listAnalysesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListAnalysesPublisher publisher = client.listAnalysesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListAnalysesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListAnalysesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAnalyses(software.amazon.awssdk.services.quicksight.model.ListAnalysesRequest)
operation.
This is a convenience which creates an instance of the
ListAnalysesRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listAssetBundleExportJobs
default CompletableFuture<ListAssetBundleExportJobsResponse> listAssetBundleExportJobs(ListAssetBundleExportJobsRequest listAssetBundleExportJobsRequest)
Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs,
ListAssetBundleExportJobs
only returns the most recent job that uses the repeated job ID.- Parameters:
listAssetBundleExportJobsRequest
-- Returns:
- A Java Future containing the result of the ListAssetBundleExportJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextToken
value isn't valid. - ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listAssetBundleExportJobs
default CompletableFuture<ListAssetBundleExportJobsResponse> listAssetBundleExportJobs(Consumer<ListAssetBundleExportJobsRequest.Builder> listAssetBundleExportJobsRequest)
Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs,
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:
- A Java Future containing the result of the ListAssetBundleExportJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextToken
value isn't valid. - ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listAssetBundleExportJobsPaginator
default ListAssetBundleExportJobsPublisher listAssetBundleExportJobsPaginator(ListAssetBundleExportJobsRequest listAssetBundleExportJobsRequest)
This is a variant of
listAssetBundleExportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListAssetBundleExportJobsPublisher publisher = client.listAssetBundleExportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListAssetBundleExportJobsPublisher publisher = client.listAssetBundleExportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssetBundleExportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsRequest)
operation.- Parameters:
listAssetBundleExportJobsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextToken
value isn't valid. - ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listAssetBundleExportJobsPaginator
default ListAssetBundleExportJobsPublisher listAssetBundleExportJobsPaginator(Consumer<ListAssetBundleExportJobsRequest.Builder> listAssetBundleExportJobsRequest)
This is a variant of
listAssetBundleExportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListAssetBundleExportJobsPublisher publisher = client.listAssetBundleExportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListAssetBundleExportJobsPublisher publisher = client.listAssetBundleExportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssetBundleExportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsRequest)
operation.
This is a convenience which creates an instance of the
ListAssetBundleExportJobsRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextToken
value isn't valid. - ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listAssetBundleImportJobs
default CompletableFuture<ListAssetBundleImportJobsResponse> listAssetBundleImportJobs(ListAssetBundleImportJobsRequest listAssetBundleImportJobsRequest)
Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs,
ListAssetBundleImportJobs
only returns the most recent job that uses the repeated job ID.- Parameters:
listAssetBundleImportJobsRequest
-- Returns:
- A Java Future containing the result of the ListAssetBundleImportJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextToken
value isn't valid. - ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listAssetBundleImportJobs
default CompletableFuture<ListAssetBundleImportJobsResponse> listAssetBundleImportJobs(Consumer<ListAssetBundleImportJobsRequest.Builder> listAssetBundleImportJobsRequest)
Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs,
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:
- A Java Future containing the result of the ListAssetBundleImportJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextToken
value isn't valid. - ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listAssetBundleImportJobsPaginator
default ListAssetBundleImportJobsPublisher listAssetBundleImportJobsPaginator(ListAssetBundleImportJobsRequest listAssetBundleImportJobsRequest)
This is a variant of
listAssetBundleImportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListAssetBundleImportJobsPublisher publisher = client.listAssetBundleImportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListAssetBundleImportJobsPublisher publisher = client.listAssetBundleImportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssetBundleImportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsRequest)
operation.- Parameters:
listAssetBundleImportJobsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextToken
value isn't valid. - ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listAssetBundleImportJobsPaginator
default ListAssetBundleImportJobsPublisher listAssetBundleImportJobsPaginator(Consumer<ListAssetBundleImportJobsRequest.Builder> listAssetBundleImportJobsRequest)
This is a variant of
listAssetBundleImportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListAssetBundleImportJobsPublisher publisher = client.listAssetBundleImportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListAssetBundleImportJobsPublisher publisher = client.listAssetBundleImportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssetBundleImportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsRequest)
operation.
This is a convenience which creates an instance of the
ListAssetBundleImportJobsRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextToken
value isn't valid. - ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDashboardVersions
default CompletableFuture<ListDashboardVersionsResponse> listDashboardVersions(ListDashboardVersionsRequest listDashboardVersionsRequest)
Lists all the versions of the dashboards in the Amazon QuickSight subscription.
- Parameters:
listDashboardVersionsRequest
-- Returns:
- A Java Future containing the result of the ListDashboardVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDashboardVersions
default CompletableFuture<ListDashboardVersionsResponse> listDashboardVersions(Consumer<ListDashboardVersionsRequest.Builder> listDashboardVersionsRequest)
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:
- A Java Future containing the result of the ListDashboardVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDashboardVersionsPaginator
default ListDashboardVersionsPublisher listDashboardVersionsPaginator(ListDashboardVersionsRequest listDashboardVersionsRequest)
This is a variant of
listDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsPublisher publisher = client.listDashboardVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsPublisher publisher = client.listDashboardVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest)
operation.- Parameters:
listDashboardVersionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDashboardVersionsPaginator
default ListDashboardVersionsPublisher listDashboardVersionsPaginator(Consumer<ListDashboardVersionsRequest.Builder> listDashboardVersionsRequest)
This is a variant of
listDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsPublisher publisher = client.listDashboardVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsPublisher publisher = client.listDashboardVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest)
operation.
This is a convenience which creates an instance of the
ListDashboardVersionsRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDashboards
default CompletableFuture<ListDashboardsResponse> listDashboards(ListDashboardsRequest listDashboardsRequest)
Lists dashboards in an Amazon Web Services account.
- Parameters:
listDashboardsRequest
-- Returns:
- A Java Future containing the result of the ListDashboards operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDashboards
default CompletableFuture<ListDashboardsResponse> listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)
Lists dashboards in an Amazon Web Services account.
This is a convenience which creates an instance of the
ListDashboardsRequest.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 Java Future containing the result of the ListDashboards operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDashboardsPaginator
default ListDashboardsPublisher listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest)
This is a variant of
listDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListDashboardsPublisher publisher = client.listDashboardsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListDashboardsPublisher publisher = client.listDashboardsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListDashboardsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListDashboardsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest)
operation.- Parameters:
listDashboardsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDashboardsPaginator
default ListDashboardsPublisher listDashboardsPaginator(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest)
This is a variant of
listDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListDashboardsPublisher publisher = client.listDashboardsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListDashboardsPublisher publisher = client.listDashboardsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListDashboardsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListDashboardsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest)
operation.
This is a convenience which creates an instance of the
ListDashboardsRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDataSets
default CompletableFuture<ListDataSetsResponse> listDataSets(ListDataSetsRequest listDataSetsRequest)
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
The permissions resource is
arn:aws:quicksight:region:aws-account-id:dataset/*
.- Parameters:
listDataSetsRequest
-- Returns:
- A Java Future containing the result of the ListDataSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDataSets
default CompletableFuture<ListDataSetsResponse> listDataSets(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest)
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
The permissions resource is
arn:aws:quicksight:region:aws-account-id:dataset/*
.
This is a convenience which creates an instance of the
ListDataSetsRequest.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 Java Future containing the result of the ListDataSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDataSetsPaginator
default ListDataSetsPublisher listDataSetsPaginator(ListDataSetsRequest listDataSetsRequest)
This is a variant of
listDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListDataSetsPublisher publisher = client.listDataSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListDataSetsPublisher publisher = client.listDataSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListDataSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListDataSetsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest)
operation.- Parameters:
listDataSetsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDataSetsPaginator
default ListDataSetsPublisher listDataSetsPaginator(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest)
This is a variant of
listDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListDataSetsPublisher publisher = client.listDataSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListDataSetsPublisher publisher = client.listDataSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListDataSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListDataSetsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest)
operation.
This is a convenience which creates an instance of the
ListDataSetsRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDataSources
default CompletableFuture<ListDataSourcesResponse> listDataSources(ListDataSourcesRequest listDataSourcesRequest)
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
- Parameters:
listDataSourcesRequest
-- Returns:
- A Java Future containing the result of the ListDataSources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDataSources
default CompletableFuture<ListDataSourcesResponse> listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
This is a convenience which creates an instance of the
ListDataSourcesRequest.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 Java Future containing the result of the ListDataSources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDataSourcesPaginator
default ListDataSourcesPublisher listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest)
This is a variant of
listDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListDataSourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListDataSourcesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest)
operation.- Parameters:
listDataSourcesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDataSourcesPaginator
default ListDataSourcesPublisher listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)
This is a variant of
listDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListDataSourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListDataSourcesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest)
operation.
This is a convenience which creates an instance of the
ListDataSourcesRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listFolderMembers
default CompletableFuture<ListFolderMembersResponse> listFolderMembers(ListFolderMembersRequest listFolderMembersRequest)
List all assets (
DASHBOARD
,ANALYSIS
, andDATASET
) in a folder.- Parameters:
listFolderMembersRequest
-- Returns:
- A Java Future containing the result of the ListFolderMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listFolderMembers
default CompletableFuture<ListFolderMembersResponse> listFolderMembers(Consumer<ListFolderMembersRequest.Builder> listFolderMembersRequest)
List all assets (
DASHBOARD
,ANALYSIS
, andDATASET
) in a folder.
This is a convenience which creates an instance of the
ListFolderMembersRequest.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 Java Future containing the result of the ListFolderMembers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listFolderMembersPaginator
default ListFolderMembersPublisher listFolderMembersPaginator(ListFolderMembersRequest listFolderMembersRequest)
This is a variant of
listFolderMembers(software.amazon.awssdk.services.quicksight.model.ListFolderMembersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListFolderMembersPublisher publisher = client.listFolderMembersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListFolderMembersPublisher publisher = client.listFolderMembersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListFolderMembersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListFolderMembersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFolderMembers(software.amazon.awssdk.services.quicksight.model.ListFolderMembersRequest)
operation.- Parameters:
listFolderMembersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listFolderMembersPaginator
default ListFolderMembersPublisher listFolderMembersPaginator(Consumer<ListFolderMembersRequest.Builder> listFolderMembersRequest)
This is a variant of
listFolderMembers(software.amazon.awssdk.services.quicksight.model.ListFolderMembersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListFolderMembersPublisher publisher = client.listFolderMembersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListFolderMembersPublisher publisher = client.listFolderMembersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListFolderMembersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListFolderMembersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFolderMembers(software.amazon.awssdk.services.quicksight.model.ListFolderMembersRequest)
operation.
This is a convenience which creates an instance of the
ListFolderMembersRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listFolders
default CompletableFuture<ListFoldersResponse> listFolders(ListFoldersRequest listFoldersRequest)
Lists all folders in an account.
- Parameters:
listFoldersRequest
-- Returns:
- A Java Future containing the result of the ListFolders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listFolders
default CompletableFuture<ListFoldersResponse> listFolders(Consumer<ListFoldersRequest.Builder> listFoldersRequest)
Lists all folders in an account.
This is a convenience which creates an instance of the
ListFoldersRequest.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 Java Future containing the result of the ListFolders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listFoldersPaginator
default ListFoldersPublisher listFoldersPaginator(ListFoldersRequest listFoldersRequest)
This is a variant of
listFolders(software.amazon.awssdk.services.quicksight.model.ListFoldersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListFoldersPublisher publisher = client.listFoldersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListFoldersPublisher publisher = client.listFoldersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListFoldersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListFoldersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFolders(software.amazon.awssdk.services.quicksight.model.ListFoldersRequest)
operation.- Parameters:
listFoldersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listFoldersPaginator
default ListFoldersPublisher listFoldersPaginator(Consumer<ListFoldersRequest.Builder> listFoldersRequest)
This is a variant of
listFolders(software.amazon.awssdk.services.quicksight.model.ListFoldersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListFoldersPublisher publisher = client.listFoldersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListFoldersPublisher publisher = client.listFoldersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListFoldersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListFoldersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFolders(software.amazon.awssdk.services.quicksight.model.ListFoldersRequest)
operation.
This is a convenience which creates an instance of the
ListFoldersRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listGroupMemberships
default CompletableFuture<ListGroupMembershipsResponse> listGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest)
Lists member users in a group.
- Parameters:
listGroupMembershipsRequest
-- Returns:
- A Java Future containing the result of the ListGroupMemberships operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listGroupMemberships
default CompletableFuture<ListGroupMembershipsResponse> listGroupMemberships(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest)
Lists member users in a group.
This is a convenience which creates an instance of the
ListGroupMembershipsRequest.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 Java Future containing the result of the ListGroupMemberships operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listGroupMembershipsPaginator
default ListGroupMembershipsPublisher listGroupMembershipsPaginator(ListGroupMembershipsRequest listGroupMembershipsRequest)
This is a variant of
listGroupMemberships(software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListGroupMembershipsPublisher publisher = client.listGroupMembershipsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListGroupMembershipsPublisher publisher = client.listGroupMembershipsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroupMemberships(software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsRequest)
operation.- Parameters:
listGroupMembershipsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listGroupMembershipsPaginator
default ListGroupMembershipsPublisher listGroupMembershipsPaginator(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest)
This is a variant of
listGroupMemberships(software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListGroupMembershipsPublisher publisher = client.listGroupMembershipsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListGroupMembershipsPublisher publisher = client.listGroupMembershipsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroupMemberships(software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsRequest)
operation.
This is a convenience which creates an instance of the
ListGroupMembershipsRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listGroups
default CompletableFuture<ListGroupsResponse> listGroups(ListGroupsRequest listGroupsRequest)
Lists all user groups in Amazon QuickSight.
- Parameters:
listGroupsRequest
-- Returns:
- A Java Future containing the result of the ListGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listGroups
default CompletableFuture<ListGroupsResponse> listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
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:
- A Java Future containing the result of the ListGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listGroupsPaginator
default ListGroupsPublisher listGroupsPaginator(ListGroupsRequest listGroupsRequest)
This is a variant of
listGroups(software.amazon.awssdk.services.quicksight.model.ListGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListGroupsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.quicksight.model.ListGroupsRequest)
operation.- Parameters:
listGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listGroupsPaginator
default ListGroupsPublisher listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest)
This is a variant of
listGroups(software.amazon.awssdk.services.quicksight.model.ListGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListGroupsPublisher publisher = client.listGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListGroupsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.quicksight.model.ListGroupsRequest)
operation.
This is a convenience which creates an instance of the
ListGroupsRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listIAMPolicyAssignments
default CompletableFuture<ListIamPolicyAssignmentsResponse> listIAMPolicyAssignments(ListIamPolicyAssignmentsRequest listIamPolicyAssignmentsRequest)
Lists the IAM policy assignments in the current Amazon QuickSight account.
- Parameters:
listIamPolicyAssignmentsRequest
-- Returns:
- A Java Future containing the result of the ListIAMPolicyAssignments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listIAMPolicyAssignments
default CompletableFuture<ListIamPolicyAssignmentsResponse> listIAMPolicyAssignments(Consumer<ListIamPolicyAssignmentsRequest.Builder> listIamPolicyAssignmentsRequest)
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:
- A Java Future containing the result of the ListIAMPolicyAssignments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listIAMPolicyAssignmentsForUser
default CompletableFuture<ListIamPolicyAssignmentsForUserResponse> listIAMPolicyAssignmentsForUser(ListIamPolicyAssignmentsForUserRequest listIamPolicyAssignmentsForUserRequest)
Lists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to.
- Parameters:
listIamPolicyAssignmentsForUserRequest
-- Returns:
- A Java Future containing the result of the ListIAMPolicyAssignmentsForUser operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConcurrentUpdatingException A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listIAMPolicyAssignmentsForUser
default CompletableFuture<ListIamPolicyAssignmentsForUserResponse> listIAMPolicyAssignmentsForUser(Consumer<ListIamPolicyAssignmentsForUserRequest.Builder> listIamPolicyAssignmentsForUserRequest)
Lists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to.
This is a convenience which creates an instance of the
ListIamPolicyAssignmentsForUserRequest.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 Java Future containing the result of the ListIAMPolicyAssignmentsForUser operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConcurrentUpdatingException A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listIAMPolicyAssignmentsForUserPaginator
default ListIAMPolicyAssignmentsForUserPublisher listIAMPolicyAssignmentsForUserPaginator(ListIamPolicyAssignmentsForUserRequest listIamPolicyAssignmentsForUserRequest)
This is a variant of
listIAMPolicyAssignmentsForUser(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsForUserPublisher publisher = client.listIAMPolicyAssignmentsForUserPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsForUserPublisher publisher = client.listIAMPolicyAssignmentsForUserPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIAMPolicyAssignmentsForUser(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserRequest)
operation.- Parameters:
listIamPolicyAssignmentsForUserRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConcurrentUpdatingException A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listIAMPolicyAssignmentsForUserPaginator
default ListIAMPolicyAssignmentsForUserPublisher listIAMPolicyAssignmentsForUserPaginator(Consumer<ListIamPolicyAssignmentsForUserRequest.Builder> listIamPolicyAssignmentsForUserRequest)
This is a variant of
listIAMPolicyAssignmentsForUser(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsForUserPublisher publisher = client.listIAMPolicyAssignmentsForUserPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsForUserPublisher publisher = client.listIAMPolicyAssignmentsForUserPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIAMPolicyAssignmentsForUser(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserRequest)
operation.
This is a convenience which creates an instance of the
ListIamPolicyAssignmentsForUserRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConcurrentUpdatingException A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listIAMPolicyAssignmentsPaginator
default ListIAMPolicyAssignmentsPublisher listIAMPolicyAssignmentsPaginator(ListIamPolicyAssignmentsRequest listIamPolicyAssignmentsRequest)
This is a variant of
listIAMPolicyAssignments(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsPublisher publisher = client.listIAMPolicyAssignmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsPublisher publisher = client.listIAMPolicyAssignmentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIAMPolicyAssignments(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsRequest)
operation.- Parameters:
listIamPolicyAssignmentsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listIAMPolicyAssignmentsPaginator
default ListIAMPolicyAssignmentsPublisher listIAMPolicyAssignmentsPaginator(Consumer<ListIamPolicyAssignmentsRequest.Builder> listIamPolicyAssignmentsRequest)
This is a variant of
listIAMPolicyAssignments(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsPublisher publisher = client.listIAMPolicyAssignmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsPublisher publisher = client.listIAMPolicyAssignmentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIAMPolicyAssignments(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsRequest)
operation.
This is a convenience which creates an instance of the
ListIamPolicyAssignmentsRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listIdentityPropagationConfigs
default CompletableFuture<ListIdentityPropagationConfigsResponse> listIdentityPropagationConfigs(ListIdentityPropagationConfigsRequest listIdentityPropagationConfigsRequest)
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:
- A Java Future containing the result of the ListIdentityPropagationConfigs operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listIdentityPropagationConfigs
default CompletableFuture<ListIdentityPropagationConfigsResponse> listIdentityPropagationConfigs(Consumer<ListIdentityPropagationConfigsRequest.Builder> listIdentityPropagationConfigsRequest)
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:
- A Java Future containing the result of the ListIdentityPropagationConfigs operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listIngestions
default CompletableFuture<ListIngestionsResponse> listIngestions(ListIngestionsRequest listIngestionsRequest)
Lists the history of SPICE ingestions for a dataset.
- Parameters:
listIngestionsRequest
-- Returns:
- A Java Future containing the result of the ListIngestions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listIngestions
default CompletableFuture<ListIngestionsResponse> listIngestions(Consumer<ListIngestionsRequest.Builder> listIngestionsRequest)
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:
- A Java Future containing the result of the ListIngestions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listIngestionsPaginator
default ListIngestionsPublisher listIngestionsPaginator(ListIngestionsRequest listIngestionsRequest)
This is a variant of
listIngestions(software.amazon.awssdk.services.quicksight.model.ListIngestionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListIngestionsPublisher publisher = client.listIngestionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListIngestionsPublisher publisher = client.listIngestionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListIngestionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListIngestionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIngestions(software.amazon.awssdk.services.quicksight.model.ListIngestionsRequest)
operation.- Parameters:
listIngestionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listIngestionsPaginator
default ListIngestionsPublisher listIngestionsPaginator(Consumer<ListIngestionsRequest.Builder> listIngestionsRequest)
This is a variant of
listIngestions(software.amazon.awssdk.services.quicksight.model.ListIngestionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListIngestionsPublisher publisher = client.listIngestionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListIngestionsPublisher publisher = client.listIngestionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListIngestionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListIngestionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIngestions(software.amazon.awssdk.services.quicksight.model.ListIngestionsRequest)
operation.
This is a convenience which creates an instance of the
ListIngestionsRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listNamespaces
default CompletableFuture<ListNamespacesResponse> listNamespaces(ListNamespacesRequest listNamespacesRequest)
Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.
- Parameters:
listNamespacesRequest
-- Returns:
- A Java Future containing the result of the ListNamespaces operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listNamespaces
default CompletableFuture<ListNamespacesResponse> listNamespaces(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest)
Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.
This is a convenience which creates an instance of the
ListNamespacesRequest.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 Java Future containing the result of the ListNamespaces operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listNamespacesPaginator
default ListNamespacesPublisher listNamespacesPaginator(ListNamespacesRequest listNamespacesRequest)
This is a variant of
listNamespaces(software.amazon.awssdk.services.quicksight.model.ListNamespacesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListNamespacesPublisher publisher = client.listNamespacesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListNamespacesPublisher publisher = client.listNamespacesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListNamespacesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListNamespacesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNamespaces(software.amazon.awssdk.services.quicksight.model.ListNamespacesRequest)
operation.- Parameters:
listNamespacesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listNamespacesPaginator
default ListNamespacesPublisher listNamespacesPaginator(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest)
This is a variant of
listNamespaces(software.amazon.awssdk.services.quicksight.model.ListNamespacesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListNamespacesPublisher publisher = client.listNamespacesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListNamespacesPublisher publisher = client.listNamespacesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListNamespacesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListNamespacesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNamespaces(software.amazon.awssdk.services.quicksight.model.ListNamespacesRequest)
operation.
This is a convenience which creates an instance of the
ListNamespacesRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listRefreshSchedules
default CompletableFuture<ListRefreshSchedulesResponse> listRefreshSchedules(ListRefreshSchedulesRequest listRefreshSchedulesRequest)
Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.
- Parameters:
listRefreshSchedulesRequest
-- Returns:
- A Java Future containing the result of the ListRefreshSchedules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listRefreshSchedules
default CompletableFuture<ListRefreshSchedulesResponse> listRefreshSchedules(Consumer<ListRefreshSchedulesRequest.Builder> listRefreshSchedulesRequest)
Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.
This is a convenience which creates an instance of the
ListRefreshSchedulesRequest.Builder
avoiding the need to create one manually viaListRefreshSchedulesRequest.builder()
- Parameters:
listRefreshSchedulesRequest
- AConsumer
that will call methods onListRefreshSchedulesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRefreshSchedules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listRoleMemberships
default CompletableFuture<ListRoleMembershipsResponse> listRoleMemberships(ListRoleMembershipsRequest listRoleMembershipsRequest)
Lists all groups that are associated with a role.
- Parameters:
listRoleMembershipsRequest
-- Returns:
- A Java Future containing the result of the ListRoleMemberships operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listRoleMemberships
default CompletableFuture<ListRoleMembershipsResponse> listRoleMemberships(Consumer<ListRoleMembershipsRequest.Builder> listRoleMembershipsRequest)
Lists all groups that are associated with a role.
This is a convenience which creates an instance of the
ListRoleMembershipsRequest.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 Java Future containing the result of the ListRoleMemberships operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listRoleMembershipsPaginator
default ListRoleMembershipsPublisher listRoleMembershipsPaginator(ListRoleMembershipsRequest listRoleMembershipsRequest)
This is a variant of
listRoleMemberships(software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListRoleMembershipsPublisher publisher = client.listRoleMembershipsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListRoleMembershipsPublisher publisher = client.listRoleMembershipsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRoleMemberships(software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsRequest)
operation.- Parameters:
listRoleMembershipsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listRoleMembershipsPaginator
default ListRoleMembershipsPublisher listRoleMembershipsPaginator(Consumer<ListRoleMembershipsRequest.Builder> listRoleMembershipsRequest)
This is a variant of
listRoleMemberships(software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListRoleMembershipsPublisher publisher = client.listRoleMembershipsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListRoleMembershipsPublisher publisher = client.listRoleMembershipsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRoleMemberships(software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsRequest)
operation.
This is a convenience which creates an instance of the
ListRoleMembershipsRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags assigned to a resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags assigned to a resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTemplateAliases
default CompletableFuture<ListTemplateAliasesResponse> listTemplateAliases(ListTemplateAliasesRequest listTemplateAliasesRequest)
Lists all the aliases of a template.
- Parameters:
listTemplateAliasesRequest
-- Returns:
- A Java Future containing the result of the ListTemplateAliases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The
NextToken
value isn't valid. - ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidNextTokenException The
- See Also:
- AWS API Documentation
-
listTemplateAliases
default CompletableFuture<ListTemplateAliasesResponse> listTemplateAliases(Consumer<ListTemplateAliasesRequest.Builder> listTemplateAliasesRequest)
Lists all the aliases of a template.
This is a convenience which creates an instance of the
ListTemplateAliasesRequest.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 Java Future containing the result of the ListTemplateAliases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The
NextToken
value isn't valid. - ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidNextTokenException The
- See Also:
- AWS API Documentation
-
listTemplateAliasesPaginator
default ListTemplateAliasesPublisher listTemplateAliasesPaginator(ListTemplateAliasesRequest listTemplateAliasesRequest)
This is a variant of
listTemplateAliases(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesPublisher publisher = client.listTemplateAliasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesPublisher publisher = client.listTemplateAliasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplateAliases(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesRequest)
operation.- Parameters:
listTemplateAliasesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The
NextToken
value isn't valid. - ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidNextTokenException The
- See Also:
- AWS API Documentation
-
listTemplateAliasesPaginator
default ListTemplateAliasesPublisher listTemplateAliasesPaginator(Consumer<ListTemplateAliasesRequest.Builder> listTemplateAliasesRequest)
This is a variant of
listTemplateAliases(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesPublisher publisher = client.listTemplateAliasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesPublisher publisher = client.listTemplateAliasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplateAliases(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesRequest)
operation.
This is a convenience which creates an instance of the
ListTemplateAliasesRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The
NextToken
value isn't valid. - ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidNextTokenException The
- See Also:
- AWS API Documentation
-
listTemplateVersions
default CompletableFuture<ListTemplateVersionsResponse> listTemplateVersions(ListTemplateVersionsRequest listTemplateVersionsRequest)
Lists all the versions of the templates in the current Amazon QuickSight account.
- Parameters:
listTemplateVersionsRequest
-- Returns:
- A Java Future containing the result of the ListTemplateVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTemplateVersions
default CompletableFuture<ListTemplateVersionsResponse> listTemplateVersions(Consumer<ListTemplateVersionsRequest.Builder> listTemplateVersionsRequest)
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:
- A Java Future containing the result of the ListTemplateVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTemplateVersionsPaginator
default ListTemplateVersionsPublisher listTemplateVersionsPaginator(ListTemplateVersionsRequest listTemplateVersionsRequest)
This is a variant of
listTemplateVersions(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsPublisher publisher = client.listTemplateVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsPublisher publisher = client.listTemplateVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplateVersions(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsRequest)
operation.- Parameters:
listTemplateVersionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTemplateVersionsPaginator
default ListTemplateVersionsPublisher listTemplateVersionsPaginator(Consumer<ListTemplateVersionsRequest.Builder> listTemplateVersionsRequest)
This is a variant of
listTemplateVersions(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsPublisher publisher = client.listTemplateVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsPublisher publisher = client.listTemplateVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplateVersions(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsRequest)
operation.
This is a convenience which creates an instance of the
ListTemplateVersionsRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTemplates
default CompletableFuture<ListTemplatesResponse> listTemplates(ListTemplatesRequest listTemplatesRequest)
Lists all the templates in the current Amazon QuickSight account.
- Parameters:
listTemplatesRequest
-- Returns:
- A Java Future containing the result of the ListTemplates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTemplates
default CompletableFuture<ListTemplatesResponse> listTemplates(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest)
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:
- A Java Future containing the result of the ListTemplates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTemplatesPaginator
default ListTemplatesPublisher listTemplatesPaginator(ListTemplatesRequest listTemplatesRequest)
This is a variant of
listTemplates(software.amazon.awssdk.services.quicksight.model.ListTemplatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListTemplatesPublisher publisher = client.listTemplatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListTemplatesPublisher publisher = client.listTemplatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListTemplatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListTemplatesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplates(software.amazon.awssdk.services.quicksight.model.ListTemplatesRequest)
operation.- Parameters:
listTemplatesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTemplatesPaginator
default ListTemplatesPublisher listTemplatesPaginator(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest)
This is a variant of
listTemplates(software.amazon.awssdk.services.quicksight.model.ListTemplatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListTemplatesPublisher publisher = client.listTemplatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListTemplatesPublisher publisher = client.listTemplatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListTemplatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListTemplatesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplates(software.amazon.awssdk.services.quicksight.model.ListTemplatesRequest)
operation.
This is a convenience which creates an instance of the
ListTemplatesRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listThemeAliases
default CompletableFuture<ListThemeAliasesResponse> listThemeAliases(ListThemeAliasesRequest listThemeAliasesRequest)
Lists all the aliases of a theme.
- Parameters:
listThemeAliasesRequest
-- Returns:
- A Java Future containing the result of the ListThemeAliases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidNextTokenException The
NextToken
value isn't valid. - InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listThemeAliases
default CompletableFuture<ListThemeAliasesResponse> listThemeAliases(Consumer<ListThemeAliasesRequest.Builder> listThemeAliasesRequest)
Lists all the aliases of a theme.
This is a convenience which creates an instance of the
ListThemeAliasesRequest.Builder
avoiding the need to create one manually viaListThemeAliasesRequest.builder()
- Parameters:
listThemeAliasesRequest
- AConsumer
that will call methods onListThemeAliasesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListThemeAliases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidNextTokenException The
NextToken
value isn't valid. - InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listThemeVersions
default CompletableFuture<ListThemeVersionsResponse> listThemeVersions(ListThemeVersionsRequest listThemeVersionsRequest)
Lists all the versions of the themes in the current Amazon Web Services account.
- Parameters:
listThemeVersionsRequest
-- Returns:
- A Java Future containing the result of the ListThemeVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextToken
value isn't valid. - InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listThemeVersions
default CompletableFuture<ListThemeVersionsResponse> listThemeVersions(Consumer<ListThemeVersionsRequest.Builder> listThemeVersionsRequest)
Lists all the versions of the themes in the current Amazon Web Services account.
This is a convenience which creates an instance of the
ListThemeVersionsRequest.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 Java Future containing the result of the ListThemeVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextToken
value isn't valid. - InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listThemeVersionsPaginator
default ListThemeVersionsPublisher listThemeVersionsPaginator(ListThemeVersionsRequest listThemeVersionsRequest)
This is a variant of
listThemeVersions(software.amazon.awssdk.services.quicksight.model.ListThemeVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListThemeVersionsPublisher publisher = client.listThemeVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListThemeVersionsPublisher publisher = client.listThemeVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListThemeVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListThemeVersionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThemeVersions(software.amazon.awssdk.services.quicksight.model.ListThemeVersionsRequest)
operation.- Parameters:
listThemeVersionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextToken
value isn't valid. - InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listThemeVersionsPaginator
default ListThemeVersionsPublisher listThemeVersionsPaginator(Consumer<ListThemeVersionsRequest.Builder> listThemeVersionsRequest)
This is a variant of
listThemeVersions(software.amazon.awssdk.services.quicksight.model.ListThemeVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListThemeVersionsPublisher publisher = client.listThemeVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListThemeVersionsPublisher publisher = client.listThemeVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListThemeVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListThemeVersionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThemeVersions(software.amazon.awssdk.services.quicksight.model.ListThemeVersionsRequest)
operation.
This is a convenience which creates an instance of the
ListThemeVersionsRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextToken
value isn't valid. - InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listThemes
default CompletableFuture<ListThemesResponse> listThemes(ListThemesRequest listThemesRequest)
Lists all the themes in the current Amazon Web Services account.
- Parameters:
listThemesRequest
-- Returns:
- A Java Future containing the result of the ListThemes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InvalidNextTokenException The
NextToken
value isn't valid. - ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listThemes
default CompletableFuture<ListThemesResponse> listThemes(Consumer<ListThemesRequest.Builder> listThemesRequest)
Lists all the themes in the current Amazon Web Services account.
This is a convenience which creates an instance of the
ListThemesRequest.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 Java Future containing the result of the ListThemes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InvalidNextTokenException The
NextToken
value isn't valid. - ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listThemesPaginator
default ListThemesPublisher listThemesPaginator(ListThemesRequest listThemesRequest)
This is a variant of
listThemes(software.amazon.awssdk.services.quicksight.model.ListThemesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListThemesPublisher publisher = client.listThemesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListThemesPublisher publisher = client.listThemesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListThemesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListThemesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThemes(software.amazon.awssdk.services.quicksight.model.ListThemesRequest)
operation.- Parameters:
listThemesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InvalidNextTokenException The
NextToken
value isn't valid. - ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listThemesPaginator
default ListThemesPublisher listThemesPaginator(Consumer<ListThemesRequest.Builder> listThemesRequest)
This is a variant of
listThemes(software.amazon.awssdk.services.quicksight.model.ListThemesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListThemesPublisher publisher = client.listThemesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListThemesPublisher publisher = client.listThemesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListThemesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListThemesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThemes(software.amazon.awssdk.services.quicksight.model.ListThemesRequest)
operation.
This is a convenience which creates an instance of the
ListThemesRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- InvalidNextTokenException The
NextToken
value isn't valid. - ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTopicRefreshSchedules
default CompletableFuture<ListTopicRefreshSchedulesResponse> listTopicRefreshSchedules(ListTopicRefreshSchedulesRequest listTopicRefreshSchedulesRequest)
Lists all of the refresh schedules for a topic.
- Parameters:
listTopicRefreshSchedulesRequest
-- Returns:
- A Java Future containing the result of the ListTopicRefreshSchedules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTopicRefreshSchedules
default CompletableFuture<ListTopicRefreshSchedulesResponse> listTopicRefreshSchedules(Consumer<ListTopicRefreshSchedulesRequest.Builder> listTopicRefreshSchedulesRequest)
Lists all of the refresh schedules for a topic.
This is a convenience which creates an instance of the
ListTopicRefreshSchedulesRequest.Builder
avoiding the need to create one manually viaListTopicRefreshSchedulesRequest.builder()
- Parameters:
listTopicRefreshSchedulesRequest
- AConsumer
that will call methods onListTopicRefreshSchedulesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTopicRefreshSchedules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTopics
default CompletableFuture<ListTopicsResponse> listTopics(ListTopicsRequest listTopicsRequest)
Lists all of the topics within an account.
- Parameters:
listTopicsRequest
-- Returns:
- A Java Future containing the result of the ListTopics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTopics
default CompletableFuture<ListTopicsResponse> listTopics(Consumer<ListTopicsRequest.Builder> listTopicsRequest)
Lists all of the topics within an account.
This is a convenience which creates an instance of the
ListTopicsRequest.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 Java Future containing the result of the ListTopics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTopicsPaginator
default ListTopicsPublisher listTopicsPaginator(ListTopicsRequest listTopicsRequest)
This is a variant of
listTopics(software.amazon.awssdk.services.quicksight.model.ListTopicsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListTopicsPublisher publisher = client.listTopicsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListTopicsPublisher publisher = client.listTopicsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListTopicsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListTopicsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTopics(software.amazon.awssdk.services.quicksight.model.ListTopicsRequest)
operation.- Parameters:
listTopicsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTopicsPaginator
default ListTopicsPublisher listTopicsPaginator(Consumer<ListTopicsRequest.Builder> listTopicsRequest)
This is a variant of
listTopics(software.amazon.awssdk.services.quicksight.model.ListTopicsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListTopicsPublisher publisher = client.listTopicsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListTopicsPublisher publisher = client.listTopicsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListTopicsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListTopicsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTopics(software.amazon.awssdk.services.quicksight.model.ListTopicsRequest)
operation.
This is a convenience which creates an instance of the
ListTopicsRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listUserGroups
default CompletableFuture<ListUserGroupsResponse> listUserGroups(ListUserGroupsRequest listUserGroupsRequest)
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
- Parameters:
listUserGroupsRequest
-- Returns:
- A Java Future containing the result of the ListUserGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listUserGroups
default CompletableFuture<ListUserGroupsResponse> listUserGroups(Consumer<ListUserGroupsRequest.Builder> listUserGroupsRequest)
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:
- A Java Future containing the result of the ListUserGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listUserGroupsPaginator
default ListUserGroupsPublisher listUserGroupsPaginator(ListUserGroupsRequest listUserGroupsRequest)
This is a variant of
listUserGroups(software.amazon.awssdk.services.quicksight.model.ListUserGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListUserGroupsPublisher publisher = client.listUserGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListUserGroupsPublisher publisher = client.listUserGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListUserGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListUserGroupsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUserGroups(software.amazon.awssdk.services.quicksight.model.ListUserGroupsRequest)
operation.- Parameters:
listUserGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listUserGroupsPaginator
default ListUserGroupsPublisher listUserGroupsPaginator(Consumer<ListUserGroupsRequest.Builder> listUserGroupsRequest)
This is a variant of
listUserGroups(software.amazon.awssdk.services.quicksight.model.ListUserGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListUserGroupsPublisher publisher = client.listUserGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListUserGroupsPublisher publisher = client.listUserGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListUserGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListUserGroupsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUserGroups(software.amazon.awssdk.services.quicksight.model.ListUserGroupsRequest)
operation.
This is a convenience which creates an instance of the
ListUserGroupsRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listUsers
default CompletableFuture<ListUsersResponse> listUsers(ListUsersRequest listUsersRequest)
Returns a list of all of the Amazon QuickSight users belonging to this account.
- Parameters:
listUsersRequest
-- Returns:
- A Java Future containing the result of the ListUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listUsers
default CompletableFuture<ListUsersResponse> listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
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:
- A Java Future containing the result of the ListUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listUsersPaginator
default ListUsersPublisher listUsersPaginator(ListUsersRequest listUsersRequest)
This is a variant of
listUsers(software.amazon.awssdk.services.quicksight.model.ListUsersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListUsersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListUsersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.quicksight.model.ListUsersRequest)
operation.- Parameters:
listUsersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listUsersPaginator
default ListUsersPublisher listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)
This is a variant of
listUsers(software.amazon.awssdk.services.quicksight.model.ListUsersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListUsersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListUsersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.quicksight.model.ListUsersRequest)
operation.
This is a convenience which creates an instance of the
ListUsersRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listVPCConnections
default CompletableFuture<ListVpcConnectionsResponse> listVPCConnections(ListVpcConnectionsRequest listVpcConnectionsRequest)
Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
- Parameters:
listVpcConnectionsRequest
-- Returns:
- A Java Future containing the result of the ListVPCConnections operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listVPCConnections
default CompletableFuture<ListVpcConnectionsResponse> listVPCConnections(Consumer<ListVpcConnectionsRequest.Builder> listVpcConnectionsRequest)
Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
This is a convenience which creates an instance of the
ListVpcConnectionsRequest.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 Java Future containing the result of the ListVPCConnections operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listVPCConnectionsPaginator
default ListVPCConnectionsPublisher listVPCConnectionsPaginator(ListVpcConnectionsRequest listVpcConnectionsRequest)
This is a variant of
listVPCConnections(software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListVPCConnectionsPublisher publisher = client.listVPCConnectionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListVPCConnectionsPublisher publisher = client.listVPCConnectionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVPCConnections(software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsRequest)
operation.- Parameters:
listVpcConnectionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listVPCConnectionsPaginator
default ListVPCConnectionsPublisher listVPCConnectionsPaginator(Consumer<ListVpcConnectionsRequest.Builder> listVpcConnectionsRequest)
This is a variant of
listVPCConnections(software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.ListVPCConnectionsPublisher publisher = client.listVPCConnectionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.ListVPCConnectionsPublisher publisher = client.listVPCConnectionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVPCConnections(software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsRequest)
operation.
This is a convenience which creates an instance of the
ListVpcConnectionsRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
putDataSetRefreshProperties
default CompletableFuture<PutDataSetRefreshPropertiesResponse> putDataSetRefreshProperties(PutDataSetRefreshPropertiesRequest putDataSetRefreshPropertiesRequest)
Creates or updates the dataset refresh properties for the dataset.
- Parameters:
putDataSetRefreshPropertiesRequest
-- Returns:
- A Java Future containing the result of the PutDataSetRefreshProperties operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- PreconditionNotMetException One or more preconditions aren't met.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
putDataSetRefreshProperties
default CompletableFuture<PutDataSetRefreshPropertiesResponse> putDataSetRefreshProperties(Consumer<PutDataSetRefreshPropertiesRequest.Builder> putDataSetRefreshPropertiesRequest)
Creates or updates the dataset refresh properties for the dataset.
This is a convenience which creates an instance of the
PutDataSetRefreshPropertiesRequest.Builder
avoiding the need to create one manually viaPutDataSetRefreshPropertiesRequest.builder()
- Parameters:
putDataSetRefreshPropertiesRequest
- AConsumer
that will call methods onPutDataSetRefreshPropertiesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutDataSetRefreshProperties operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- PreconditionNotMetException One or more preconditions aren't met.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
registerUser
default CompletableFuture<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. 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:
- A Java Future containing the result of the RegisterUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
registerUser
default CompletableFuture<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. 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:
- A Java Future containing the result of the RegisterUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
restoreAnalysis
default CompletableFuture<RestoreAnalysisResponse> restoreAnalysis(RestoreAnalysisRequest restoreAnalysisRequest)
Restores an analysis.
- Parameters:
restoreAnalysisRequest
-- Returns:
- A Java Future containing the result of the RestoreAnalysis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
restoreAnalysis
default CompletableFuture<RestoreAnalysisResponse> restoreAnalysis(Consumer<RestoreAnalysisRequest.Builder> restoreAnalysisRequest)
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:
- A Java Future containing the result of the RestoreAnalysis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
searchAnalyses
default CompletableFuture<SearchAnalysesResponse> searchAnalyses(SearchAnalysesRequest searchAnalysesRequest)
Searches for analyses that belong to the user specified in the filter.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
- Parameters:
searchAnalysesRequest
-- Returns:
- A Java Future containing the result of the SearchAnalyses operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
searchAnalyses
default CompletableFuture<SearchAnalysesResponse> searchAnalyses(Consumer<SearchAnalysesRequest.Builder> searchAnalysesRequest)
Searches for analyses that belong to the user specified in the filter.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This is a convenience which creates an instance of the
SearchAnalysesRequest.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 Java Future containing the result of the SearchAnalyses operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
searchAnalysesPaginator
default SearchAnalysesPublisher searchAnalysesPaginator(SearchAnalysesRequest searchAnalysesRequest)
This is a variant of
searchAnalyses(software.amazon.awssdk.services.quicksight.model.SearchAnalysesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.SearchAnalysesPublisher publisher = client.searchAnalysesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.SearchAnalysesPublisher publisher = client.searchAnalysesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchAnalysesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchAnalysesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchAnalyses(software.amazon.awssdk.services.quicksight.model.SearchAnalysesRequest)
operation.- Parameters:
searchAnalysesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
searchAnalysesPaginator
default SearchAnalysesPublisher searchAnalysesPaginator(Consumer<SearchAnalysesRequest.Builder> searchAnalysesRequest)
This is a variant of
searchAnalyses(software.amazon.awssdk.services.quicksight.model.SearchAnalysesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.SearchAnalysesPublisher publisher = client.searchAnalysesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.SearchAnalysesPublisher publisher = client.searchAnalysesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchAnalysesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchAnalysesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchAnalyses(software.amazon.awssdk.services.quicksight.model.SearchAnalysesRequest)
operation.
This is a convenience which creates an instance of the
SearchAnalysesRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
searchDashboards
default CompletableFuture<SearchDashboardsResponse> searchDashboards(SearchDashboardsRequest searchDashboardsRequest)
Searches for dashboards that belong to a user.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
- Parameters:
searchDashboardsRequest
-- Returns:
- A Java Future containing the result of the SearchDashboards operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
searchDashboards
default CompletableFuture<SearchDashboardsResponse> searchDashboards(Consumer<SearchDashboardsRequest.Builder> searchDashboardsRequest)
Searches for dashboards that belong to a user.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This is a convenience which creates an instance of the
SearchDashboardsRequest.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 Java Future containing the result of the SearchDashboards operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
searchDashboardsPaginator
default SearchDashboardsPublisher searchDashboardsPaginator(SearchDashboardsRequest searchDashboardsRequest)
This is a variant of
searchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.SearchDashboardsPublisher publisher = client.searchDashboardsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsPublisher publisher = client.searchDashboardsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchDashboardsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchDashboardsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest)
operation.- Parameters:
searchDashboardsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
searchDashboardsPaginator
default SearchDashboardsPublisher searchDashboardsPaginator(Consumer<SearchDashboardsRequest.Builder> searchDashboardsRequest)
This is a variant of
searchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.SearchDashboardsPublisher publisher = client.searchDashboardsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsPublisher publisher = client.searchDashboardsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchDashboardsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchDashboardsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest)
operation.
This is a convenience which creates an instance of the
SearchDashboardsRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
searchDataSets
default CompletableFuture<SearchDataSetsResponse> searchDataSets(SearchDataSetsRequest searchDataSetsRequest)
Use the
SearchDataSets
operation to search for datasets that belong to an account.- Parameters:
searchDataSetsRequest
-- Returns:
- A Java Future containing the result of the SearchDataSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
searchDataSets
default CompletableFuture<SearchDataSetsResponse> searchDataSets(Consumer<SearchDataSetsRequest.Builder> searchDataSetsRequest)
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:
- A Java Future containing the result of the SearchDataSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
searchDataSetsPaginator
default SearchDataSetsPublisher searchDataSetsPaginator(SearchDataSetsRequest searchDataSetsRequest)
This is a variant of
searchDataSets(software.amazon.awssdk.services.quicksight.model.SearchDataSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.SearchDataSetsPublisher publisher = client.searchDataSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.SearchDataSetsPublisher publisher = client.searchDataSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchDataSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchDataSetsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDataSets(software.amazon.awssdk.services.quicksight.model.SearchDataSetsRequest)
operation.- Parameters:
searchDataSetsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
searchDataSetsPaginator
default SearchDataSetsPublisher searchDataSetsPaginator(Consumer<SearchDataSetsRequest.Builder> searchDataSetsRequest)
This is a variant of
searchDataSets(software.amazon.awssdk.services.quicksight.model.SearchDataSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.SearchDataSetsPublisher publisher = client.searchDataSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.SearchDataSetsPublisher publisher = client.searchDataSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchDataSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchDataSetsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDataSets(software.amazon.awssdk.services.quicksight.model.SearchDataSetsRequest)
operation.
This is a convenience which creates an instance of the
SearchDataSetsRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
searchDataSources
default CompletableFuture<SearchDataSourcesResponse> searchDataSources(SearchDataSourcesRequest searchDataSourcesRequest)
Use the
SearchDataSources
operation to search for data sources that belong to an account.- Parameters:
searchDataSourcesRequest
-- Returns:
- A Java Future containing the result of the SearchDataSources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
searchDataSources
default CompletableFuture<SearchDataSourcesResponse> searchDataSources(Consumer<SearchDataSourcesRequest.Builder> searchDataSourcesRequest)
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:
- A Java Future containing the result of the SearchDataSources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
searchDataSourcesPaginator
default SearchDataSourcesPublisher searchDataSourcesPaginator(SearchDataSourcesRequest searchDataSourcesRequest)
This is a variant of
searchDataSources(software.amazon.awssdk.services.quicksight.model.SearchDataSourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.SearchDataSourcesPublisher publisher = client.searchDataSourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.SearchDataSourcesPublisher publisher = client.searchDataSourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchDataSourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchDataSourcesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDataSources(software.amazon.awssdk.services.quicksight.model.SearchDataSourcesRequest)
operation.- Parameters:
searchDataSourcesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
searchDataSourcesPaginator
default SearchDataSourcesPublisher searchDataSourcesPaginator(Consumer<SearchDataSourcesRequest.Builder> searchDataSourcesRequest)
This is a variant of
searchDataSources(software.amazon.awssdk.services.quicksight.model.SearchDataSourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.SearchDataSourcesPublisher publisher = client.searchDataSourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.SearchDataSourcesPublisher publisher = client.searchDataSourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchDataSourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchDataSourcesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDataSources(software.amazon.awssdk.services.quicksight.model.SearchDataSourcesRequest)
operation.
This is a convenience which creates an instance of the
SearchDataSourcesRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidNextTokenException The
NextToken
value isn't valid. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
searchFolders
default CompletableFuture<SearchFoldersResponse> searchFolders(SearchFoldersRequest searchFoldersRequest)
Searches the subfolders in a folder.
- Parameters:
searchFoldersRequest
-- Returns:
- A Java Future containing the result of the SearchFolders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
searchFolders
default CompletableFuture<SearchFoldersResponse> searchFolders(Consumer<SearchFoldersRequest.Builder> searchFoldersRequest)
Searches the subfolders in a folder.
This is a convenience which creates an instance of the
SearchFoldersRequest.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 Java Future containing the result of the SearchFolders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
searchFoldersPaginator
default SearchFoldersPublisher searchFoldersPaginator(SearchFoldersRequest searchFoldersRequest)
This is a variant of
searchFolders(software.amazon.awssdk.services.quicksight.model.SearchFoldersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.SearchFoldersPublisher publisher = client.searchFoldersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.SearchFoldersPublisher publisher = client.searchFoldersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchFoldersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchFoldersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchFolders(software.amazon.awssdk.services.quicksight.model.SearchFoldersRequest)
operation.- Parameters:
searchFoldersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
searchFoldersPaginator
default SearchFoldersPublisher searchFoldersPaginator(Consumer<SearchFoldersRequest.Builder> searchFoldersRequest)
This is a variant of
searchFolders(software.amazon.awssdk.services.quicksight.model.SearchFoldersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.SearchFoldersPublisher publisher = client.searchFoldersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.SearchFoldersPublisher publisher = client.searchFoldersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchFoldersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchFoldersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchFolders(software.amazon.awssdk.services.quicksight.model.SearchFoldersRequest)
operation.
This is a convenience which creates an instance of the
SearchFoldersRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InvalidRequestException You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
searchGroups
default CompletableFuture<SearchGroupsResponse> searchGroups(SearchGroupsRequest searchGroupsRequest)
Use the
SearchGroups
operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.- Parameters:
searchGroupsRequest
-- Returns:
- A Java Future containing the result of the SearchGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
searchGroups
default CompletableFuture<SearchGroupsResponse> searchGroups(Consumer<SearchGroupsRequest.Builder> searchGroupsRequest)
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:
- A Java Future containing the result of the SearchGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
searchGroupsPaginator
default SearchGroupsPublisher searchGroupsPaginator(SearchGroupsRequest searchGroupsRequest)
This is a variant of
searchGroups(software.amazon.awssdk.services.quicksight.model.SearchGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.SearchGroupsPublisher publisher = client.searchGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.SearchGroupsPublisher publisher = client.searchGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchGroupsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchGroups(software.amazon.awssdk.services.quicksight.model.SearchGroupsRequest)
operation.- Parameters:
searchGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
searchGroupsPaginator
default SearchGroupsPublisher searchGroupsPaginator(Consumer<SearchGroupsRequest.Builder> searchGroupsRequest)
This is a variant of
searchGroups(software.amazon.awssdk.services.quicksight.model.SearchGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.quicksight.paginators.SearchGroupsPublisher publisher = client.searchGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.quicksight.paginators.SearchGroupsPublisher publisher = client.searchGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.quicksight.model.SearchGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.quicksight.model.SearchGroupsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchGroups(software.amazon.awssdk.services.quicksight.model.SearchGroupsRequest)
operation.
This is a convenience which creates an instance of the
SearchGroupsRequest.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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InvalidNextTokenException The
NextToken
value isn't valid. - PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
startAssetBundleExportJob
default CompletableFuture<StartAssetBundleExportJobResponse> startAssetBundleExportJob(StartAssetBundleExportJobRequest startAssetBundleExportJobRequest)
Starts an Asset Bundle export job.
An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a
DescribeAssetBundleExportJob
API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with 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:
- A Java Future containing the result of the StartAssetBundleExportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- LimitExceededException A limit is exceeded.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
startAssetBundleExportJob
default CompletableFuture<StartAssetBundleExportJobResponse> startAssetBundleExportJob(Consumer<StartAssetBundleExportJobRequest.Builder> startAssetBundleExportJobRequest)
Starts an Asset Bundle export job.
An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a
DescribeAssetBundleExportJob
API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with 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:
- A Java Future containing the result of the StartAssetBundleExportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- LimitExceededException A limit is exceeded.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
startAssetBundleImportJob
default CompletableFuture<StartAssetBundleImportJobResponse> startAssetBundleImportJob(StartAssetBundleImportJobRequest startAssetBundleImportJobRequest)
Starts an Asset Bundle import job.
An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently.
The API caller must have the necessary
"create"
,"describe"
, and"update"
permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.- Parameters:
startAssetBundleImportJobRequest
-- Returns:
- A Java Future containing the result of the StartAssetBundleImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- LimitExceededException A limit is exceeded.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
startAssetBundleImportJob
default CompletableFuture<StartAssetBundleImportJobResponse> startAssetBundleImportJob(Consumer<StartAssetBundleImportJobRequest.Builder> startAssetBundleImportJobRequest)
Starts an Asset Bundle import job.
An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 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:
- A Java Future containing the result of the StartAssetBundleImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- LimitExceededException A limit is exceeded.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
startDashboardSnapshotJob
default CompletableFuture<StartDashboardSnapshotJobResponse> startDashboardSnapshotJob(StartDashboardSnapshotJobRequest startDashboardSnapshotJobRequest)
Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.
-
1 Paginated PDF
-
1 Excel workbook that includes up to 5 table or pivot table visuals
-
5 CSVs from table or pivot table visuals
The status of a submitted job can be polled with the
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:
- A Java Future containing the result of the StartDashboardSnapshotJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- UnsupportedPricingPlanException This error indicates that you are calling an embedding operation in
Amazon QuickSight without the required pricing plan on your Amazon Web Services account. Before you can
use embedding for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon
QuickSight. You can do this on the Manage Amazon QuickSight page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrl
API operation with the--identity-type ANONYMOUS
option. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
startDashboardSnapshotJob
default CompletableFuture<StartDashboardSnapshotJobResponse> startDashboardSnapshotJob(Consumer<StartDashboardSnapshotJobRequest.Builder> startDashboardSnapshotJobRequest)
Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.
-
1 Paginated PDF
-
1 Excel workbook that includes up to 5 table or pivot table visuals
-
5 CSVs from table or pivot table visuals
The status of a submitted job can be polled with the
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:
- A Java Future containing the result of the StartDashboardSnapshotJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- UnsupportedPricingPlanException This error indicates that you are calling an embedding operation in
Amazon QuickSight without the required pricing plan on your Amazon Web Services account. Before you can
use embedding for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon
QuickSight. You can do this on the Manage Amazon QuickSight page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrl
API operation with the--identity-type ANONYMOUS
option. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the
TagResource
operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, template, 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:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException A limit is exceeded.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the
TagResource
operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, template, 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:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException A limit is exceeded.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag or tags from a resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes a tag or tags from a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateAccountCustomization
default CompletableFuture<UpdateAccountCustomizationResponse> updateAccountCustomization(UpdateAccountCustomizationRequest updateAccountCustomizationRequest)
Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.
You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the
DescribeAccountCustomization
API operation.- Parameters:
updateAccountCustomizationRequest
-- Returns:
- A Java Future containing the result of the UpdateAccountCustomization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateAccountCustomization
default CompletableFuture<UpdateAccountCustomizationResponse> updateAccountCustomization(Consumer<UpdateAccountCustomizationRequest.Builder> updateAccountCustomizationRequest)
Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.
You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the
DescribeAccountCustomization
API operation.
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:
- A Java Future containing the result of the UpdateAccountCustomization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateAccountSettings
default CompletableFuture<UpdateAccountSettingsResponse> updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest)
Updates the Amazon QuickSight settings in your Amazon Web Services account.
- Parameters:
updateAccountSettingsRequest
-- Returns:
- A Java Future containing the result of the UpdateAccountSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateAccountSettings
default CompletableFuture<UpdateAccountSettingsResponse> updateAccountSettings(Consumer<UpdateAccountSettingsRequest.Builder> updateAccountSettingsRequest)
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:
- A Java Future containing the result of the UpdateAccountSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateAnalysis
default CompletableFuture<UpdateAnalysisResponse> updateAnalysis(UpdateAnalysisRequest updateAnalysisRequest)
Updates an analysis in Amazon QuickSight
- Parameters:
updateAnalysisRequest
-- Returns:
- A Java Future containing the result of the UpdateAnalysis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateAnalysis
default CompletableFuture<UpdateAnalysisResponse> updateAnalysis(Consumer<UpdateAnalysisRequest.Builder> updateAnalysisRequest)
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:
- A Java Future containing the result of the UpdateAnalysis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceExistsException The resource specified already exists.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateAnalysisPermissions
default CompletableFuture<UpdateAnalysisPermissionsResponse> updateAnalysisPermissions(UpdateAnalysisPermissionsRequest updateAnalysisPermissionsRequest)
Updates the read and write permissions for an analysis.
- Parameters:
updateAnalysisPermissionsRequest
-- Returns:
- A Java Future containing the result of the UpdateAnalysisPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateAnalysisPermissions
default CompletableFuture<UpdateAnalysisPermissionsResponse> updateAnalysisPermissions(Consumer<UpdateAnalysisPermissionsRequest.Builder> updateAnalysisPermissionsRequest)
Updates the read and write permissions for an analysis.
This is a convenience which creates an instance of the
UpdateAnalysisPermissionsRequest.Builder
avoiding the need to create one manually viaUpdateAnalysisPermissionsRequest.builder()
- Parameters:
updateAnalysisPermissionsRequest
- AConsumer
that will call methods onUpdateAnalysisPermissionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateAnalysisPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateDashboard
default CompletableFuture<UpdateDashboardResponse> updateDashboard(UpdateDashboardRequest updateDashboardRequest)
Updates a dashboard in an Amazon Web Services account.
Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the
UpdateDashboardPublishedVersion
API operation.- Parameters:
updateDashboardRequest
-- Returns:
- A Java Future containing the result of the UpdateDashboard operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- LimitExceededException A limit is exceeded.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateDashboard
default CompletableFuture<UpdateDashboardResponse> updateDashboard(Consumer<UpdateDashboardRequest.Builder> updateDashboardRequest)
Updates a dashboard in an Amazon Web Services account.
Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the
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:
- A Java Future containing the result of the UpdateDashboard operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- LimitExceededException A limit is exceeded.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateDashboardLinks
default CompletableFuture<UpdateDashboardLinksResponse> updateDashboardLinks(UpdateDashboardLinksRequest updateDashboardLinksRequest)
Updates the linked analyses on a dashboard.
- Parameters:
updateDashboardLinksRequest
-- Returns:
- A Java Future containing the result of the UpdateDashboardLinks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateDashboardLinks
default CompletableFuture<UpdateDashboardLinksResponse> updateDashboardLinks(Consumer<UpdateDashboardLinksRequest.Builder> updateDashboardLinksRequest)
Updates the linked analyses on a dashboard.
This is a convenience which creates an instance of the
UpdateDashboardLinksRequest.Builder
avoiding the need to create one manually viaUpdateDashboardLinksRequest.builder()
- Parameters:
updateDashboardLinksRequest
- AConsumer
that will call methods onUpdateDashboardLinksRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateDashboardLinks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateDashboardPermissions
default CompletableFuture<UpdateDashboardPermissionsResponse> updateDashboardPermissions(UpdateDashboardPermissionsRequest updateDashboardPermissionsRequest)
Updates read and write permissions on a dashboard.
- Parameters:
updateDashboardPermissionsRequest
-- Returns:
- A Java Future containing the result of the UpdateDashboardPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateDashboardPermissions
default CompletableFuture<UpdateDashboardPermissionsResponse> updateDashboardPermissions(Consumer<UpdateDashboardPermissionsRequest.Builder> updateDashboardPermissionsRequest)
Updates read and write permissions on a dashboard.
This is a convenience which creates an instance of the
UpdateDashboardPermissionsRequest.Builder
avoiding the need to create one manually viaUpdateDashboardPermissionsRequest.builder()
- Parameters:
updateDashboardPermissionsRequest
- AConsumer
that will call methods onUpdateDashboardPermissionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateDashboardPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateDashboardPublishedVersion
default CompletableFuture<UpdateDashboardPublishedVersionResponse> updateDashboardPublishedVersion(UpdateDashboardPublishedVersionRequest updateDashboardPublishedVersionRequest)
Updates the published version of a dashboard.
- Parameters:
updateDashboardPublishedVersionRequest
-- Returns:
- A Java Future containing the result of the UpdateDashboardPublishedVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateDashboardPublishedVersion
default CompletableFuture<UpdateDashboardPublishedVersionResponse> updateDashboardPublishedVersion(Consumer<UpdateDashboardPublishedVersionRequest.Builder> updateDashboardPublishedVersionRequest)
Updates the published version of a dashboard.
This is a convenience which creates an instance of the
UpdateDashboardPublishedVersionRequest.Builder
avoiding the need to create one manually viaUpdateDashboardPublishedVersionRequest.builder()
- Parameters:
updateDashboardPublishedVersionRequest
- AConsumer
that will call methods onUpdateDashboardPublishedVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateDashboardPublishedVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateDataSet
default CompletableFuture<UpdateDataSetResponse> updateDataSet(UpdateDataSetRequest updateDataSetRequest)
Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.
- Parameters:
updateDataSetRequest
-- Returns:
- A Java Future containing the result of the UpdateDataSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateDataSet
default CompletableFuture<UpdateDataSetResponse> updateDataSet(Consumer<UpdateDataSetRequest.Builder> updateDataSetRequest)
Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.
This is a convenience which creates an instance of the
UpdateDataSetRequest.Builder
avoiding the need to create one manually viaUpdateDataSetRequest.builder()
- Parameters:
updateDataSetRequest
- AConsumer
that will call methods onUpdateDataSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateDataSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateDataSetPermissions
default CompletableFuture<UpdateDataSetPermissionsResponse> updateDataSetPermissions(UpdateDataSetPermissionsRequest updateDataSetPermissionsRequest)
Updates the permissions on a dataset.
The permissions resource is
arn:aws:quicksight:region:aws-account-id:dataset/data-set-id
.- Parameters:
updateDataSetPermissionsRequest
-- Returns:
- A Java Future containing the result of the UpdateDataSetPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateDataSetPermissions
default CompletableFuture<UpdateDataSetPermissionsResponse> updateDataSetPermissions(Consumer<UpdateDataSetPermissionsRequest.Builder> updateDataSetPermissionsRequest)
Updates the permissions on a dataset.
The permissions resource is
arn:aws:quicksight:region:aws-account-id:dataset/data-set-id
.
This is a convenience which creates an instance of the
UpdateDataSetPermissionsRequest.Builder
avoiding the need to create one manually viaUpdateDataSetPermissionsRequest.builder()
- Parameters:
updateDataSetPermissionsRequest
- AConsumer
that will call methods onUpdateDataSetPermissionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateDataSetPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateDataSource
default CompletableFuture<UpdateDataSourceResponse> updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)
Updates a data source.
- Parameters:
updateDataSourceRequest
-- Returns:
- A Java Future containing the result of the UpdateDataSource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateDataSource
default CompletableFuture<UpdateDataSourceResponse> updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest)
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:
- A Java Future containing the result of the UpdateDataSource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateDataSourcePermissions
default CompletableFuture<UpdateDataSourcePermissionsResponse> updateDataSourcePermissions(UpdateDataSourcePermissionsRequest updateDataSourcePermissionsRequest)
Updates the permissions to a data source.
- Parameters:
updateDataSourcePermissionsRequest
-- Returns:
- A Java Future containing the result of the UpdateDataSourcePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateDataSourcePermissions
default CompletableFuture<UpdateDataSourcePermissionsResponse> updateDataSourcePermissions(Consumer<UpdateDataSourcePermissionsRequest.Builder> updateDataSourcePermissionsRequest)
Updates the permissions to a data source.
This is a convenience which creates an instance of the
UpdateDataSourcePermissionsRequest.Builder
avoiding the need to create one manually viaUpdateDataSourcePermissionsRequest.builder()
- Parameters:
updateDataSourcePermissionsRequest
- AConsumer
that will call methods onUpdateDataSourcePermissionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateDataSourcePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateFolder
default CompletableFuture<UpdateFolderResponse> updateFolder(UpdateFolderRequest updateFolderRequest)
Updates the name of a folder.
- Parameters:
updateFolderRequest
-- Returns:
- A Java Future containing the result of the UpdateFolder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateFolder
default CompletableFuture<UpdateFolderResponse> updateFolder(Consumer<UpdateFolderRequest.Builder> updateFolderRequest)
Updates the name of a folder.
This is a convenience which creates an instance of the
UpdateFolderRequest.Builder
avoiding the need to create one manually viaUpdateFolderRequest.builder()
- Parameters:
updateFolderRequest
- AConsumer
that will call methods onUpdateFolderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateFolder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateFolderPermissions
default CompletableFuture<UpdateFolderPermissionsResponse> updateFolderPermissions(UpdateFolderPermissionsRequest updateFolderPermissionsRequest)
Updates permissions of a folder.
- Parameters:
updateFolderPermissionsRequest
-- Returns:
- A Java Future containing the result of the UpdateFolderPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateFolderPermissions
default CompletableFuture<UpdateFolderPermissionsResponse> updateFolderPermissions(Consumer<UpdateFolderPermissionsRequest.Builder> updateFolderPermissionsRequest)
Updates permissions of a folder.
This is a convenience which creates an instance of the
UpdateFolderPermissionsRequest.Builder
avoiding the need to create one manually viaUpdateFolderPermissionsRequest.builder()
- Parameters:
updateFolderPermissionsRequest
- AConsumer
that will call methods onUpdateFolderPermissionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateFolderPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateGroup
default CompletableFuture<UpdateGroupResponse> updateGroup(UpdateGroupRequest updateGroupRequest)
Changes a group description.
- Parameters:
updateGroupRequest
-- Returns:
- A Java Future containing the result of the UpdateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateGroup
default CompletableFuture<UpdateGroupResponse> updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)
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:
- A Java Future containing the result of the UpdateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateIAMPolicyAssignment
default CompletableFuture<UpdateIamPolicyAssignmentResponse> updateIAMPolicyAssignment(UpdateIamPolicyAssignmentRequest updateIamPolicyAssignmentRequest)
Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in
Identities
.- Parameters:
updateIamPolicyAssignmentRequest
-- Returns:
- A Java Future containing the result of the UpdateIAMPolicyAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConcurrentUpdatingException A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateIAMPolicyAssignment
default CompletableFuture<UpdateIamPolicyAssignmentResponse> updateIAMPolicyAssignment(Consumer<UpdateIamPolicyAssignmentRequest.Builder> updateIamPolicyAssignmentRequest)
Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in
Identities
.
This is a convenience which creates an instance of the
UpdateIamPolicyAssignmentRequest.Builder
avoiding the need to create one manually viaUpdateIamPolicyAssignmentRequest.builder()
- Parameters:
updateIamPolicyAssignmentRequest
- AConsumer
that will call methods onUpdateIamPolicyAssignmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateIAMPolicyAssignment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConcurrentUpdatingException A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateIdentityPropagationConfig
default CompletableFuture<UpdateIdentityPropagationConfigResponse> updateIdentityPropagationConfig(UpdateIdentityPropagationConfigRequest updateIdentityPropagationConfigRequest)
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:
- A Java Future containing the result of the UpdateIdentityPropagationConfig operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateIdentityPropagationConfig
default CompletableFuture<UpdateIdentityPropagationConfigResponse> updateIdentityPropagationConfig(Consumer<UpdateIdentityPropagationConfigRequest.Builder> updateIdentityPropagationConfigRequest)
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:
- A Java Future containing the result of the UpdateIdentityPropagationConfig operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateIpRestriction
default CompletableFuture<UpdateIpRestrictionResponse> updateIpRestriction(UpdateIpRestrictionRequest updateIpRestrictionRequest)
Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the
IpRestrictionRule
,VpcIdRestrictionRule
, orVpcEndpointIdRestrictionRule
. To use this operation, you must provide the entire map of rules. You can use theDescribeIpRestriction
operation to get the current rule map.- Parameters:
updateIpRestrictionRequest
-- Returns:
- A Java Future containing the result of the UpdateIpRestriction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException A limit is exceeded.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateIpRestriction
default CompletableFuture<UpdateIpRestrictionResponse> updateIpRestriction(Consumer<UpdateIpRestrictionRequest.Builder> updateIpRestrictionRequest)
Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the
IpRestrictionRule
,VpcIdRestrictionRule
, orVpcEndpointIdRestrictionRule
. To use this operation, you must provide the entire map of rules. You can use 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:
- A Java Future containing the result of the UpdateIpRestriction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- LimitExceededException A limit is exceeded.
- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateKeyRegistration
default CompletableFuture<UpdateKeyRegistrationResponse> updateKeyRegistration(UpdateKeyRegistrationRequest updateKeyRegistrationRequest)
Updates a customer managed key in a Amazon QuickSight account.
- Parameters:
updateKeyRegistrationRequest
-- Returns:
- A Java Future containing the result of the UpdateKeyRegistration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateKeyRegistration
default CompletableFuture<UpdateKeyRegistrationResponse> updateKeyRegistration(Consumer<UpdateKeyRegistrationRequest.Builder> updateKeyRegistrationRequest)
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:
- A Java Future containing the result of the UpdateKeyRegistration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updatePublicSharingSettings
default CompletableFuture<UpdatePublicSharingSettingsResponse> updatePublicSharingSettings(UpdatePublicSharingSettingsRequest updatePublicSharingSettingsRequest)
Use the
UpdatePublicSharingSettings
operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard.To use this operation, turn on session capacity pricing for your Amazon QuickSight account.
Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon QuickSight, see Using Amazon QuickSight with IAM in the Amazon QuickSight User Guide.
- Parameters:
updatePublicSharingSettingsRequest
-- Returns:
- A Java Future containing the result of the UpdatePublicSharingSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedPricingPlanException This error indicates that you are calling an embedding operation in
Amazon QuickSight without the required pricing plan on your Amazon Web Services account. Before you can
use embedding for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon
QuickSight. You can do this on the Manage Amazon QuickSight page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrl
API operation with the--identity-type ANONYMOUS
option. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updatePublicSharingSettings
default CompletableFuture<UpdatePublicSharingSettingsResponse> updatePublicSharingSettings(Consumer<UpdatePublicSharingSettingsRequest.Builder> updatePublicSharingSettingsRequest)
Use the
UpdatePublicSharingSettings
operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard.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:
- A Java Future containing the result of the UpdatePublicSharingSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedPricingPlanException This error indicates that you are calling an embedding operation in
Amazon QuickSight without the required pricing plan on your Amazon Web Services account. Before you can
use embedding for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon
QuickSight. You can do this on the Manage Amazon QuickSight page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrl
API operation with the--identity-type ANONYMOUS
option. - InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateRefreshSchedule
default CompletableFuture<UpdateRefreshScheduleResponse> updateRefreshSchedule(UpdateRefreshScheduleRequest updateRefreshScheduleRequest)
Updates a refresh schedule for a dataset.
- Parameters:
updateRefreshScheduleRequest
-- Returns:
- A Java Future containing the result of the UpdateRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateRefreshSchedule
default CompletableFuture<UpdateRefreshScheduleResponse> updateRefreshSchedule(Consumer<UpdateRefreshScheduleRequest.Builder> updateRefreshScheduleRequest)
Updates a refresh schedule for a dataset.
This is a convenience which creates an instance of the
UpdateRefreshScheduleRequest.Builder
avoiding the need to create one manually viaUpdateRefreshScheduleRequest.builder()
- Parameters:
updateRefreshScheduleRequest
- AConsumer
that will call methods onUpdateRefreshScheduleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- LimitExceededException A limit is exceeded.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateRoleCustomPermission
default CompletableFuture<UpdateRoleCustomPermissionResponse> updateRoleCustomPermission(UpdateRoleCustomPermissionRequest updateRoleCustomPermissionRequest)
Updates the custom permissions that are associated with a role.
- Parameters:
updateRoleCustomPermissionRequest
-- Returns:
- A Java Future containing the result of the UpdateRoleCustomPermission operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateRoleCustomPermission
default CompletableFuture<UpdateRoleCustomPermissionResponse> updateRoleCustomPermission(Consumer<UpdateRoleCustomPermissionRequest.Builder> updateRoleCustomPermissionRequest)
Updates the custom permissions that are associated with a role.
This is a convenience which creates an instance of the
UpdateRoleCustomPermissionRequest.Builder
avoiding the need to create one manually viaUpdateRoleCustomPermissionRequest.builder()
- Parameters:
updateRoleCustomPermissionRequest
- AConsumer
that will call methods onUpdateRoleCustomPermissionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateRoleCustomPermission operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateSPICECapacityConfiguration
default CompletableFuture<UpdateSpiceCapacityConfigurationResponse> updateSPICECapacityConfiguration(UpdateSpiceCapacityConfigurationRequest updateSpiceCapacityConfigurationRequest)
Updates the SPICE capacity configuration for a Amazon QuickSight account.
- Parameters:
updateSpiceCapacityConfigurationRequest
-- Returns:
- A Java Future containing the result of the UpdateSPICECapacityConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateSPICECapacityConfiguration
default CompletableFuture<UpdateSpiceCapacityConfigurationResponse> updateSPICECapacityConfiguration(Consumer<UpdateSpiceCapacityConfigurationRequest.Builder> updateSpiceCapacityConfigurationRequest)
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:
- A Java Future containing the result of the UpdateSPICECapacityConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateTemplate
default CompletableFuture<UpdateTemplateResponse> updateTemplate(UpdateTemplateRequest updateTemplateRequest)
Updates a template from an existing Amazon QuickSight analysis or another template.
- Parameters:
updateTemplateRequest
-- Returns:
- A Java Future containing the result of the UpdateTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- LimitExceededException A limit is exceeded.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateTemplate
default CompletableFuture<UpdateTemplateResponse> updateTemplate(Consumer<UpdateTemplateRequest.Builder> updateTemplateRequest)
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:
- A Java Future containing the result of the UpdateTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- LimitExceededException A limit is exceeded.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateTemplateAlias
default CompletableFuture<UpdateTemplateAliasResponse> updateTemplateAlias(UpdateTemplateAliasRequest updateTemplateAliasRequest)
Updates the template alias of a template.
- Parameters:
updateTemplateAliasRequest
-- Returns:
- A Java Future containing the result of the UpdateTemplateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateTemplateAlias
default CompletableFuture<UpdateTemplateAliasResponse> updateTemplateAlias(Consumer<UpdateTemplateAliasRequest.Builder> updateTemplateAliasRequest)
Updates the template alias of a template.
This is a convenience which creates an instance of the
UpdateTemplateAliasRequest.Builder
avoiding the need to create one manually viaUpdateTemplateAliasRequest.builder()
- Parameters:
updateTemplateAliasRequest
- AConsumer
that will call methods onUpdateTemplateAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateTemplateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateTemplatePermissions
default CompletableFuture<UpdateTemplatePermissionsResponse> updateTemplatePermissions(UpdateTemplatePermissionsRequest updateTemplatePermissionsRequest)
Updates the resource permissions for a template.
- Parameters:
updateTemplatePermissionsRequest
-- Returns:
- A Java Future containing the result of the UpdateTemplatePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateTemplatePermissions
default CompletableFuture<UpdateTemplatePermissionsResponse> updateTemplatePermissions(Consumer<UpdateTemplatePermissionsRequest.Builder> updateTemplatePermissionsRequest)
Updates the resource permissions for a template.
This is a convenience which creates an instance of the
UpdateTemplatePermissionsRequest.Builder
avoiding the need to create one manually viaUpdateTemplatePermissionsRequest.builder()
- Parameters:
updateTemplatePermissionsRequest
- AConsumer
that will call methods onUpdateTemplatePermissionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateTemplatePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateTheme
default CompletableFuture<UpdateThemeResponse> updateTheme(UpdateThemeRequest updateThemeRequest)
Updates a theme.
- Parameters:
updateThemeRequest
-- Returns:
- A Java Future containing the result of the UpdateTheme operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateTheme
default CompletableFuture<UpdateThemeResponse> updateTheme(Consumer<UpdateThemeRequest.Builder> updateThemeRequest)
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:
- A Java Future containing the result of the UpdateTheme operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateThemeAlias
default CompletableFuture<UpdateThemeAliasResponse> updateThemeAlias(UpdateThemeAliasRequest updateThemeAliasRequest)
Updates an alias of a theme.
- Parameters:
updateThemeAliasRequest
-- Returns:
- A Java Future containing the result of the UpdateThemeAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateThemeAlias
default CompletableFuture<UpdateThemeAliasResponse> updateThemeAlias(Consumer<UpdateThemeAliasRequest.Builder> updateThemeAliasRequest)
Updates an alias of a theme.
This is a convenience which creates an instance of the
UpdateThemeAliasRequest.Builder
avoiding the need to create one manually viaUpdateThemeAliasRequest.builder()
- Parameters:
updateThemeAliasRequest
- AConsumer
that will call methods onUpdateThemeAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateThemeAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceExistsException The resource specified already exists.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateThemePermissions
default CompletableFuture<UpdateThemePermissionsResponse> updateThemePermissions(UpdateThemePermissionsRequest updateThemePermissionsRequest)
Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example
"quicksight:DescribeTheme"
.Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions:
-
User
-
"quicksight:DescribeTheme"
-
"quicksight:DescribeThemeAlias"
-
"quicksight:ListThemeAliases"
-
"quicksight:ListThemeVersions"
-
-
Owner
-
"quicksight:DescribeTheme"
-
"quicksight:DescribeThemeAlias"
-
"quicksight:ListThemeAliases"
-
"quicksight:ListThemeVersions"
-
"quicksight:DeleteTheme"
-
"quicksight:UpdateTheme"
-
"quicksight:CreateThemeAlias"
-
"quicksight:DeleteThemeAlias"
-
"quicksight:UpdateThemeAlias"
-
"quicksight:UpdateThemePermissions"
-
"quicksight:DescribeThemePermissions"
-
-
To specify no permissions, omit the permissions list.
- Parameters:
updateThemePermissionsRequest
-- Returns:
- A Java Future containing the result of the UpdateThemePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
updateThemePermissions
default CompletableFuture<UpdateThemePermissionsResponse> updateThemePermissions(Consumer<UpdateThemePermissionsRequest.Builder> updateThemePermissionsRequest)
Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example
"quicksight:DescribeTheme"
.Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions:
-
User
-
"quicksight:DescribeTheme"
-
"quicksight:DescribeThemeAlias"
-
"quicksight:ListThemeAliases"
-
"quicksight:ListThemeVersions"
-
-
Owner
-
"quicksight:DescribeTheme"
-
"quicksight:DescribeThemeAlias"
-
"quicksight:ListThemeAliases"
-
"quicksight:ListThemeVersions"
-
"quicksight:DeleteTheme"
-
"quicksight:UpdateTheme"
-
"quicksight:CreateThemeAlias"
-
"quicksight:DeleteThemeAlias"
-
"quicksight:UpdateThemeAlias"
-
"quicksight:UpdateThemePermissions"
-
"quicksight:DescribeThemePermissions"
-
-
To specify no permissions, omit the permissions list.
This is a convenience which creates an instance of the
UpdateThemePermissionsRequest.Builder
avoiding the need to create one manually viaUpdateThemePermissionsRequest.builder()
- Parameters:
updateThemePermissionsRequest
- AConsumer
that will call methods onUpdateThemePermissionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateThemePermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
-
updateTopic
default CompletableFuture<UpdateTopicResponse> updateTopic(UpdateTopicRequest updateTopicRequest)
Updates a topic.
- Parameters:
updateTopicRequest
-- Returns:
- A Java Future containing the result of the UpdateTopic operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateTopic
default CompletableFuture<UpdateTopicResponse> updateTopic(Consumer<UpdateTopicRequest.Builder> updateTopicRequest)
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:
- A Java Future containing the result of the UpdateTopic operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateTopicPermissions
default CompletableFuture<UpdateTopicPermissionsResponse> updateTopicPermissions(UpdateTopicPermissionsRequest updateTopicPermissionsRequest)
Updates the permissions of a topic.
- Parameters:
updateTopicPermissionsRequest
-- Returns:
- A Java Future containing the result of the UpdateTopicPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateTopicPermissions
default CompletableFuture<UpdateTopicPermissionsResponse> updateTopicPermissions(Consumer<UpdateTopicPermissionsRequest.Builder> updateTopicPermissionsRequest)
Updates the permissions of a topic.
This is a convenience which creates an instance of the
UpdateTopicPermissionsRequest.Builder
avoiding the need to create one manually viaUpdateTopicPermissionsRequest.builder()
- Parameters:
updateTopicPermissionsRequest
- AConsumer
that will call methods onUpdateTopicPermissionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateTopicPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ThrottlingException Access is throttled.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- LimitExceededException A limit is exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateTopicRefreshSchedule
default CompletableFuture<UpdateTopicRefreshScheduleResponse> updateTopicRefreshSchedule(UpdateTopicRefreshScheduleRequest updateTopicRefreshScheduleRequest)
Updates a topic refresh schedule.
- Parameters:
updateTopicRefreshScheduleRequest
-- Returns:
- A Java Future containing the result of the UpdateTopicRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateTopicRefreshSchedule
default CompletableFuture<UpdateTopicRefreshScheduleResponse> updateTopicRefreshSchedule(Consumer<UpdateTopicRefreshScheduleRequest.Builder> updateTopicRefreshScheduleRequest)
Updates a topic refresh schedule.
This is a convenience which creates an instance of the
UpdateTopicRefreshScheduleRequest.Builder
avoiding the need to create one manually viaUpdateTopicRefreshScheduleRequest.builder()
- Parameters:
updateTopicRefreshScheduleRequest
- AConsumer
that will call methods onUpdateTopicRefreshScheduleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateTopicRefreshSchedule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ResourceExistsException The resource specified already exists.
- ThrottlingException Access is throttled.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateUser
default CompletableFuture<UpdateUserResponse> updateUser(UpdateUserRequest updateUserRequest)
Updates an Amazon QuickSight user.
- Parameters:
updateUserRequest
-- Returns:
- A Java Future containing the result of the UpdateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateUser
default CompletableFuture<UpdateUserResponse> updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)
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:
- A Java Future containing the result of the UpdateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- PreconditionNotMetException One or more preconditions aren't met.
- InternalFailureException An internal failure occurred.
- ResourceUnavailableException This resource is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateVPCConnection
default CompletableFuture<UpdateVpcConnectionResponse> updateVPCConnection(UpdateVpcConnectionRequest updateVpcConnectionRequest)
Updates a VPC connection.
- Parameters:
updateVpcConnectionRequest
-- Returns:
- A Java Future containing the result of the UpdateVPCConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateVPCConnection
default CompletableFuture<UpdateVpcConnectionResponse> updateVPCConnection(Consumer<UpdateVpcConnectionRequest.Builder> updateVpcConnectionRequest)
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:
- A Java Future containing the result of the UpdateVPCConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
- ConflictException Updating or deleting a resource can cause an inconsistent state.
- InvalidParameterValueException One or more parameters has a value that isn't valid.
- LimitExceededException A limit is exceeded.
- ResourceNotFoundException One or more resources can't be found.
- ThrottlingException Access is throttled.
- UnsupportedUserEditionException This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- QuickSightException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
serviceClientConfiguration
default QuickSightServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
-
create
static QuickSightAsyncClient create()
Create aQuickSightAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.
-
builder
static QuickSightAsyncClientBuilder builder()
Create a builder that can be used to configure and create aQuickSightAsyncClient
.
-
-