Interface QuickSightClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface QuickSightClient extends AwsClient
Service client for accessing Amazon QuickSight. This can be created using the staticbuilder()method.Amazon QuickSight API Reference Amazon QuickSight is a fully managed, serverless business intelligence service for the Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_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
-
batchCreateTopicReviewedAnswer
default BatchCreateTopicReviewedAnswerResponse batchCreateTopicReviewedAnswer(BatchCreateTopicReviewedAnswerRequest batchCreateTopicReviewedAnswerRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates new reviewed answers for a Q Topic.
- Parameters:
batchCreateTopicReviewedAnswerRequest-- Returns:
- Result of the BatchCreateTopicReviewedAnswer operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
batchCreateTopicReviewedAnswer
default BatchCreateTopicReviewedAnswerResponse batchCreateTopicReviewedAnswer(Consumer<BatchCreateTopicReviewedAnswerRequest.Builder> batchCreateTopicReviewedAnswerRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates new reviewed answers for a Q Topic.
This is a convenience which creates an instance of the
BatchCreateTopicReviewedAnswerRequest.Builderavoiding the need to create one manually viaBatchCreateTopicReviewedAnswerRequest.builder()- Parameters:
batchCreateTopicReviewedAnswerRequest- AConsumerthat will call methods onBatchCreateTopicReviewedAnswerRequest.Builderto create a request.- Returns:
- Result of the BatchCreateTopicReviewedAnswer operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
batchDeleteTopicReviewedAnswer
default BatchDeleteTopicReviewedAnswerResponse batchDeleteTopicReviewedAnswer(BatchDeleteTopicReviewedAnswerRequest batchDeleteTopicReviewedAnswerRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, ConflictException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes reviewed answers for Q Topic.
- Parameters:
batchDeleteTopicReviewedAnswerRequest-- Returns:
- Result of the BatchDeleteTopicReviewedAnswer operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
batchDeleteTopicReviewedAnswer
default BatchDeleteTopicReviewedAnswerResponse batchDeleteTopicReviewedAnswer(Consumer<BatchDeleteTopicReviewedAnswerRequest.Builder> batchDeleteTopicReviewedAnswerRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, ConflictException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes reviewed answers for Q Topic.
This is a convenience which creates an instance of the
BatchDeleteTopicReviewedAnswerRequest.Builderavoiding the need to create one manually viaBatchDeleteTopicReviewedAnswerRequest.builder()- Parameters:
batchDeleteTopicReviewedAnswerRequest- AConsumerthat will call methods onBatchDeleteTopicReviewedAnswerRequest.Builderto create a request.- Returns:
- Result of the BatchDeleteTopicReviewedAnswer operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
cancelIngestion
default CancelIngestionResponse cancelIngestion(CancelIngestionRequest cancelIngestionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ResourceExistsException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Cancels an ongoing ingestion of data into SPICE.
- Parameters:
cancelIngestionRequest-- Returns:
- Result of the CancelIngestion operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
cancelIngestion
default CancelIngestionResponse cancelIngestion(Consumer<CancelIngestionRequest.Builder> cancelIngestionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ResourceExistsException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Cancels an ongoing ingestion of data into SPICE.
This is a convenience which creates an instance of the
CancelIngestionRequest.Builderavoiding the need to create one manually viaCancelIngestionRequest.builder()- Parameters:
cancelIngestionRequest- AConsumerthat will call methods onCancelIngestionRequest.Builderto create a request.- Returns:
- Result of the CancelIngestion operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
createAccountCustomization
default CreateAccountCustomizationResponse createAccountCustomization(CreateAccountCustomizationRequest createAccountCustomizationRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the
CreateAccountCustomizationorUpdateAccountCustomizationAPI operation. To further customize QuickSight by removing QuickSight sample assets and videos for all new users, see Customizing 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
DescribeAccountCustomizationAPI operation.Before you use the
CreateAccountCustomizationAPI operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using theDescribeThemePermissionsAPI operation. To share the theme, grant permissions by using theUpdateThemePermissionsAPI operation.- Parameters:
createAccountCustomizationRequest-- Returns:
- Result of the CreateAccountCustomization operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
createAccountCustomization
default CreateAccountCustomizationResponse createAccountCustomization(Consumer<CreateAccountCustomizationRequest.Builder> createAccountCustomizationRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the
CreateAccountCustomizationorUpdateAccountCustomizationAPI operation. To further customize QuickSight by removing QuickSight sample assets and videos for all new users, see Customizing 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
DescribeAccountCustomizationAPI operation.Before you use the
CreateAccountCustomizationAPI operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using theDescribeThemePermissionsAPI operation. To share the theme, grant permissions by using theUpdateThemePermissionsAPI operation.
This is a convenience which creates an instance of the
CreateAccountCustomizationRequest.Builderavoiding the need to create one manually viaCreateAccountCustomizationRequest.builder()- Parameters:
createAccountCustomizationRequest- AConsumerthat will call methods onCreateAccountCustomizationRequest.Builderto create a request.- Returns:
- Result of the CreateAccountCustomization operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
createAccountSubscription
default CreateAccountSubscriptionResponse createAccountSubscription(CreateAccountSubscriptionRequest createAccountSubscriptionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ResourceExistsException, PreconditionNotMetException, ConflictException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Creates an QuickSight account, or subscribes to 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 QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for QuickSight in the QuickSight User Guide.
If your IAM policy includes both the
SubscribeandCreateAccountSubscriptionactions, make sure that both actions are set toAllow. If either action is set toDeny, theDenyaction prevails and your API call fails.You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to QuickSight, see Passing IAM roles to QuickSight in the QuickSight User Guide.
You can't set default resource access on the new account from the QuickSight API. Instead, add default resource access from the 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 QuickSight User Guide.
- Parameters:
createAccountSubscriptionRequest-- Returns:
- Result of the CreateAccountSubscription operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
createAccountSubscription
default CreateAccountSubscriptionResponse createAccountSubscription(Consumer<CreateAccountSubscriptionRequest.Builder> createAccountSubscriptionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ResourceExistsException, PreconditionNotMetException, ConflictException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Creates an QuickSight account, or subscribes to 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 QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for QuickSight in the QuickSight User Guide.
If your IAM policy includes both the
SubscribeandCreateAccountSubscriptionactions, make sure that both actions are set toAllow. If either action is set toDeny, theDenyaction prevails and your API call fails.You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to QuickSight, see Passing IAM roles to QuickSight in the QuickSight User Guide.
You can't set default resource access on the new account from the QuickSight API. Instead, add default resource access from the 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 QuickSight User Guide.
This is a convenience which creates an instance of the
CreateAccountSubscriptionRequest.Builderavoiding the need to create one manually viaCreateAccountSubscriptionRequest.builder()- Parameters:
createAccountSubscriptionRequest- AConsumerthat will call methods onCreateAccountSubscriptionRequest.Builderto create a request.- Returns:
- Result of the CreateAccountSubscription operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
createAnalysis
default CreateAnalysisResponse createAnalysis(CreateAnalysisRequest createAnalysisRequest) throws ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, ResourceExistsException, ConflictException, UnsupportedUserEditionException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an
AnalysisDefinition.- Parameters:
createAnalysisRequest-- Returns:
- Result of the CreateAnalysis operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
createAnalysis
default CreateAnalysisResponse createAnalysis(Consumer<CreateAnalysisRequest.Builder> createAnalysisRequest) throws ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, ResourceExistsException, ConflictException, UnsupportedUserEditionException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an
AnalysisDefinition.
This is a convenience which creates an instance of the
CreateAnalysisRequest.Builderavoiding the need to create one manually viaCreateAnalysisRequest.builder()- Parameters:
createAnalysisRequest- AConsumerthat will call methods onCreateAnalysisRequest.Builderto create a request.- Returns:
- Result of the CreateAnalysis operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
createBrand
default CreateBrandResponse createBrand(CreateBrandRequest createBrandRequest) throws ThrottlingException, InvalidRequestException, LimitExceededException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, QuickSightException
Creates an QuickSight brand.
- Parameters:
createBrandRequest-- Returns:
- Result of the CreateBrand operation returned by the service.
- Throws:
ThrottlingException- Access is throttled.InvalidRequestException- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.LimitExceededException- A limit is exceeded.ConflictException- Updating or deleting a resource can cause an inconsistent state.AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.InternalServerException- An internal service exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createBrand
default CreateBrandResponse createBrand(Consumer<CreateBrandRequest.Builder> createBrandRequest) throws ThrottlingException, InvalidRequestException, LimitExceededException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, QuickSightException
Creates an QuickSight brand.
This is a convenience which creates an instance of the
CreateBrandRequest.Builderavoiding the need to create one manually viaCreateBrandRequest.builder()- Parameters:
createBrandRequest- AConsumerthat will call methods onCreateBrandRequest.Builderto create a request.- Returns:
- Result of the CreateBrand operation returned by the service.
- Throws:
ThrottlingException- Access is throttled.InvalidRequestException- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.LimitExceededException- A limit is exceeded.ConflictException- Updating or deleting a resource can cause an inconsistent state.AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.InternalServerException- An internal service exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createCustomPermissions
default CreateCustomPermissionsResponse createCustomPermissions(CreateCustomPermissionsRequest createCustomPermissionsRequest) throws ConflictException, AccessDeniedException, ResourceNotFoundException, ResourceExistsException, InvalidParameterValueException, ThrottlingException, PreconditionNotMetException, LimitExceededException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Creates a custom permissions profile.
- Parameters:
createCustomPermissionsRequest-- Returns:
- Result of the CreateCustomPermissions operation returned by the service.
- Throws:
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.ResourceNotFoundException- One or more resources can't be found.ResourceExistsException- The resource specified already exists.InvalidParameterValueException- One or more parameters has a value that isn't valid.ThrottlingException- Access is throttled.PreconditionNotMetException- One or more preconditions aren't met.LimitExceededException- A limit is exceeded.InternalFailureException- An internal failure occurred.ResourceUnavailableException- This resource is currently unavailable.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createCustomPermissions
default CreateCustomPermissionsResponse createCustomPermissions(Consumer<CreateCustomPermissionsRequest.Builder> createCustomPermissionsRequest) throws ConflictException, AccessDeniedException, ResourceNotFoundException, ResourceExistsException, InvalidParameterValueException, ThrottlingException, PreconditionNotMetException, LimitExceededException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Creates a custom permissions profile.
This is a convenience which creates an instance of the
CreateCustomPermissionsRequest.Builderavoiding the need to create one manually viaCreateCustomPermissionsRequest.builder()- Parameters:
createCustomPermissionsRequest- AConsumerthat will call methods onCreateCustomPermissionsRequest.Builderto create a request.- Returns:
- Result of the CreateCustomPermissions operation returned by the service.
- Throws:
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.ResourceNotFoundException- One or more resources can't be found.ResourceExistsException- The resource specified already exists.InvalidParameterValueException- One or more parameters has a value that isn't valid.ThrottlingException- Access is throttled.PreconditionNotMetException- One or more preconditions aren't met.LimitExceededException- A limit is exceeded.InternalFailureException- An internal failure occurred.ResourceUnavailableException- This resource is currently unavailable.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createDashboard
default CreateDashboardResponse createDashboard(CreateDashboardRequest createDashboardRequest) throws ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, ResourceExistsException, ConflictException, UnsupportedUserEditionException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a dashboard from either a template or directly with a
DashboardDefinition. To first create a template, see theCreateTemplateAPI operation.A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
- Parameters:
createDashboardRequest-- Returns:
- Result of the CreateDashboard operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
createDashboard
default CreateDashboardResponse createDashboard(Consumer<CreateDashboardRequest.Builder> createDashboardRequest) throws ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, ResourceExistsException, ConflictException, UnsupportedUserEditionException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a dashboard from either a template or directly with a
DashboardDefinition. To first create a template, see theCreateTemplateAPI operation.A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share 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.Builderavoiding the need to create one manually viaCreateDashboardRequest.builder()- Parameters:
createDashboardRequest- AConsumerthat will call methods onCreateDashboardRequest.Builderto create a request.- Returns:
- Result of the CreateDashboard operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
createDataSet
default CreateDataSetResponse createDataSet(CreateDataSetRequest createDataSetRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
- Parameters:
createDataSetRequest-- Returns:
- Result of the CreateDataSet operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
createDataSet
default CreateDataSetResponse createDataSet(Consumer<CreateDataSetRequest.Builder> createDataSetRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
This is a convenience which creates an instance of the
CreateDataSetRequest.Builderavoiding the need to create one manually viaCreateDataSetRequest.builder()- Parameters:
createDataSetRequest- AConsumerthat will call methods onCreateDataSetRequest.Builderto create a request.- Returns:
- Result of the CreateDataSet operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
createDataSource
default CreateDataSourceResponse createDataSource(CreateDataSourceRequest createDataSourceRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceNotFoundException, ResourceExistsException, ThrottlingException, CustomerManagedKeyUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a data source.
- Parameters:
createDataSourceRequest-- Returns:
- Result of the CreateDataSource operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.CustomerManagedKeyUnavailableException- The customer managed key that is registered to your QuickSight account is unavailable.InternalFailureException- An internal failure occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createDataSource
default CreateDataSourceResponse createDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceNotFoundException, ResourceExistsException, ThrottlingException, CustomerManagedKeyUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a data source.
This is a convenience which creates an instance of the
CreateDataSourceRequest.Builderavoiding the need to create one manually viaCreateDataSourceRequest.builder()- Parameters:
createDataSourceRequest- AConsumerthat will call methods onCreateDataSourceRequest.Builderto create a request.- Returns:
- Result of the CreateDataSource operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.CustomerManagedKeyUnavailableException- The customer managed key that is registered to your QuickSight account is unavailable.InternalFailureException- An internal failure occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createFolder
default CreateFolderResponse createFolder(CreateFolderRequest createFolderRequest) throws ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, ResourceExistsException, ConflictException, UnsupportedUserEditionException, AccessDeniedException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates an empty shared folder.
- Parameters:
createFolderRequest-- Returns:
- Result of the CreateFolder operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
createFolder
default CreateFolderResponse createFolder(Consumer<CreateFolderRequest.Builder> createFolderRequest) throws ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, ResourceExistsException, ConflictException, UnsupportedUserEditionException, AccessDeniedException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates an empty shared folder.
This is a convenience which creates an instance of the
CreateFolderRequest.Builderavoiding the need to create one manually viaCreateFolderRequest.builder()- Parameters:
createFolderRequest- AConsumerthat will call methods onCreateFolderRequest.Builderto create a request.- Returns:
- Result of the CreateFolder operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
createFolderMembership
default CreateFolderMembershipResponse createFolderMembership(CreateFolderMembershipRequest createFolderMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ResourceExistsException, ThrottlingException, LimitExceededException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
- Parameters:
createFolderMembershipRequest-- Returns:
- Result of the CreateFolderMembership operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
createFolderMembership
default CreateFolderMembershipResponse createFolderMembership(Consumer<CreateFolderMembershipRequest.Builder> createFolderMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ResourceExistsException, ThrottlingException, LimitExceededException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
This is a convenience which creates an instance of the
CreateFolderMembershipRequest.Builderavoiding the need to create one manually viaCreateFolderMembershipRequest.builder()- Parameters:
createFolderMembershipRequest- AConsumerthat will call methods onCreateFolderMembershipRequest.Builderto create a request.- Returns:
- Result of the CreateFolderMembership operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
createGroup
default CreateGroupResponse createGroup(CreateGroupRequest createGroupRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, LimitExceededException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Use the
CreateGroupoperation to create a group in QuickSight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact Amazon Web Services Support.The permissions resource is
arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name>.The response is a group object.
- Parameters:
createGroupRequest- The request object for this operation.- Returns:
- Result of the CreateGroup operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
createGroup
default CreateGroupResponse createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, LimitExceededException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Use the
CreateGroupoperation to create a group in 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.Builderavoiding the need to create one manually viaCreateGroupRequest.builder()- Parameters:
createGroupRequest- AConsumerthat will call methods onCreateGroupRequest.Builderto create a request. The request object for this operation.- Returns:
- Result of the CreateGroup operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
createGroupMembership
default CreateGroupMembershipResponse createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Adds an Amazon QuickSight user to an Amazon QuickSight group.
- Parameters:
createGroupMembershipRequest-- Returns:
- Result of the CreateGroupMembership operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
createGroupMembership
default CreateGroupMembershipResponse createGroupMembership(Consumer<CreateGroupMembershipRequest.Builder> createGroupMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Adds an Amazon QuickSight user to an Amazon QuickSight group.
This is a convenience which creates an instance of the
CreateGroupMembershipRequest.Builderavoiding the need to create one manually viaCreateGroupMembershipRequest.builder()- Parameters:
createGroupMembershipRequest- AConsumerthat will call methods onCreateGroupMembershipRequest.Builderto create a request.- Returns:
- Result of the CreateGroupMembership operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
createIAMPolicyAssignment
default CreateIamPolicyAssignmentResponse createIAMPolicyAssignment(CreateIamPolicyAssignmentRequest createIamPolicyAssignmentRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConcurrentUpdatingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.
- Parameters:
createIamPolicyAssignmentRequest-- Returns:
- Result of the CreateIAMPolicyAssignment operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
createIAMPolicyAssignment
default CreateIamPolicyAssignmentResponse createIAMPolicyAssignment(Consumer<CreateIamPolicyAssignmentRequest.Builder> createIamPolicyAssignmentRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConcurrentUpdatingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.
This is a convenience which creates an instance of the
CreateIamPolicyAssignmentRequest.Builderavoiding the need to create one manually viaCreateIamPolicyAssignmentRequest.builder()- Parameters:
createIamPolicyAssignmentRequest- AConsumerthat will call methods onCreateIamPolicyAssignmentRequest.Builderto create a request.- Returns:
- Result of the CreateIAMPolicyAssignment operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
createIngestion
default CreateIngestionResponse createIngestion(CreateIngestionRequest createIngestionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, ResourceExistsException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time.
Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
- Parameters:
createIngestionRequest-- Returns:
- Result of the CreateIngestion operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
createIngestion
default CreateIngestionResponse createIngestion(Consumer<CreateIngestionRequest.Builder> createIngestionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, ResourceExistsException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time.
Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
This is a convenience which creates an instance of the
CreateIngestionRequest.Builderavoiding the need to create one manually viaCreateIngestionRequest.builder()- Parameters:
createIngestionRequest- AConsumerthat will call methods onCreateIngestionRequest.Builderto create a request.- Returns:
- Result of the CreateIngestion operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
createNamespace
default CreateNamespaceResponse createNamespace(CreateNamespaceRequest createNamespaceRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, ResourceExistsException, PreconditionNotMetException, ConflictException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
A namespace allows you to isolate the 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 QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.
- Parameters:
createNamespaceRequest-- Returns:
- Result of the CreateNamespace operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
createNamespace
default CreateNamespaceResponse createNamespace(Consumer<CreateNamespaceRequest.Builder> createNamespaceRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, ResourceExistsException, PreconditionNotMetException, ConflictException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
A namespace allows you to isolate the 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 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.Builderavoiding the need to create one manually viaCreateNamespaceRequest.builder()- Parameters:
createNamespaceRequest- AConsumerthat will call methods onCreateNamespaceRequest.Builderto create a request.- Returns:
- Result of the CreateNamespace operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
createRefreshSchedule
default CreateRefreshScheduleResponse createRefreshSchedule(CreateRefreshScheduleRequest createRefreshScheduleRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, ResourceExistsException, PreconditionNotMetException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
- Parameters:
createRefreshScheduleRequest-- Returns:
- Result of the CreateRefreshSchedule operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
createRefreshSchedule
default CreateRefreshScheduleResponse createRefreshSchedule(Consumer<CreateRefreshScheduleRequest.Builder> createRefreshScheduleRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, ResourceExistsException, PreconditionNotMetException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
This is a convenience which creates an instance of the
CreateRefreshScheduleRequest.Builderavoiding the need to create one manually viaCreateRefreshScheduleRequest.builder()- Parameters:
createRefreshScheduleRequest- AConsumerthat will call methods onCreateRefreshScheduleRequest.Builderto create a request.- Returns:
- Result of the CreateRefreshSchedule operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
createRoleMembership
default CreateRoleMembershipResponse createRoleMembership(CreateRoleMembershipRequest createRoleMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Use
CreateRoleMembershipto add an existing QuickSight group to an existing role.- Parameters:
createRoleMembershipRequest-- Returns:
- Result of the CreateRoleMembership operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
createRoleMembership
default CreateRoleMembershipResponse createRoleMembership(Consumer<CreateRoleMembershipRequest.Builder> createRoleMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Use
CreateRoleMembershipto add an existing QuickSight group to an existing role.
This is a convenience which creates an instance of the
CreateRoleMembershipRequest.Builderavoiding the need to create one manually viaCreateRoleMembershipRequest.builder()- Parameters:
createRoleMembershipRequest- AConsumerthat will call methods onCreateRoleMembershipRequest.Builderto create a request.- Returns:
- Result of the CreateRoleMembership operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
createTemplate
default CreateTemplateResponse createTemplate(CreateTemplateRequest createTemplateRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, LimitExceededException, UnsupportedUserEditionException, ConflictException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a template either from a
TemplateDefinitionor from an existing QuickSight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
- Parameters:
createTemplateRequest-- Returns:
- Result of the CreateTemplate operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
createTemplate
default CreateTemplateResponse createTemplate(Consumer<CreateTemplateRequest.Builder> createTemplateRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, LimitExceededException, UnsupportedUserEditionException, ConflictException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a template either from a
TemplateDefinitionor from an existing QuickSight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.A template is an entity in 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.Builderavoiding the need to create one manually viaCreateTemplateRequest.builder()- Parameters:
createTemplateRequest- AConsumerthat will call methods onCreateTemplateRequest.Builderto create a request.- Returns:
- Result of the CreateTemplate operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
createTemplateAlias
default CreateTemplateAliasResponse createTemplateAlias(CreateTemplateAliasRequest createTemplateAliasRequest) throws ThrottlingException, ResourceNotFoundException, ConflictException, ResourceExistsException, LimitExceededException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a template alias for a template.
- Parameters:
createTemplateAliasRequest-- Returns:
- Result of the CreateTemplateAlias operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
createTemplateAlias
default CreateTemplateAliasResponse createTemplateAlias(Consumer<CreateTemplateAliasRequest.Builder> createTemplateAliasRequest) throws ThrottlingException, ResourceNotFoundException, ConflictException, ResourceExistsException, LimitExceededException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a template alias for a template.
This is a convenience which creates an instance of the
CreateTemplateAliasRequest.Builderavoiding the need to create one manually viaCreateTemplateAliasRequest.builder()- Parameters:
createTemplateAliasRequest- AConsumerthat will call methods onCreateTemplateAliasRequest.Builderto create a request.- Returns:
- Result of the CreateTemplateAlias operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
createTheme
default CreateThemeResponse createTheme(CreateThemeRequest createThemeRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a theme.
A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.
- Parameters:
createThemeRequest-- Returns:
- Result of the CreateTheme operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
createTheme
default CreateThemeResponse createTheme(Consumer<CreateThemeRequest.Builder> createThemeRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a theme.
A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.
This is a convenience which creates an instance of the
CreateThemeRequest.Builderavoiding the need to create one manually viaCreateThemeRequest.builder()- Parameters:
createThemeRequest- AConsumerthat will call methods onCreateThemeRequest.Builderto create a request.- Returns:
- Result of the CreateTheme operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
createThemeAlias
default CreateThemeAliasResponse createThemeAlias(CreateThemeAliasRequest createThemeAliasRequest) throws ConflictException, InvalidParameterValueException, LimitExceededException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a theme alias for a theme.
- Parameters:
createThemeAliasRequest-- Returns:
- Result of the CreateThemeAlias operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
createThemeAlias
default CreateThemeAliasResponse createThemeAlias(Consumer<CreateThemeAliasRequest.Builder> createThemeAliasRequest) throws ConflictException, InvalidParameterValueException, LimitExceededException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a theme alias for a theme.
This is a convenience which creates an instance of the
CreateThemeAliasRequest.Builderavoiding the need to create one manually viaCreateThemeAliasRequest.builder()- Parameters:
createThemeAliasRequest- AConsumerthat will call methods onCreateThemeAliasRequest.Builderto create a request.- Returns:
- Result of the CreateThemeAlias operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
createTopic
default CreateTopicResponse createTopic(CreateTopicRequest createTopicRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceNotFoundException, ResourceExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a new Q topic.
- Parameters:
createTopicRequest-- Returns:
- Result of the CreateTopic operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
createTopic
default CreateTopicResponse createTopic(Consumer<CreateTopicRequest.Builder> createTopicRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceNotFoundException, ResourceExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a new Q topic.
This is a convenience which creates an instance of the
CreateTopicRequest.Builderavoiding the need to create one manually viaCreateTopicRequest.builder()- Parameters:
createTopicRequest- AConsumerthat will call methods onCreateTopicRequest.Builderto create a request.- Returns:
- Result of the CreateTopic operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
createTopicRefreshSchedule
default CreateTopicRefreshScheduleResponse createTopicRefreshSchedule(CreateTopicRefreshScheduleRequest createTopicRefreshScheduleRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceNotFoundException, ResourceExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a topic refresh schedule.
- Parameters:
createTopicRefreshScheduleRequest-- Returns:
- Result of the CreateTopicRefreshSchedule operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
createTopicRefreshSchedule
default CreateTopicRefreshScheduleResponse createTopicRefreshSchedule(Consumer<CreateTopicRefreshScheduleRequest.Builder> createTopicRefreshScheduleRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceNotFoundException, ResourceExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a topic refresh schedule.
This is a convenience which creates an instance of the
CreateTopicRefreshScheduleRequest.Builderavoiding the need to create one manually viaCreateTopicRefreshScheduleRequest.builder()- Parameters:
createTopicRefreshScheduleRequest- AConsumerthat will call methods onCreateTopicRefreshScheduleRequest.Builderto create a request.- Returns:
- Result of the CreateTopicRefreshSchedule operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
createVPCConnection
default CreateVpcConnectionResponse createVPCConnection(CreateVpcConnectionRequest createVpcConnectionRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceExistsException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a new VPC connection.
- Parameters:
createVpcConnectionRequest-- Returns:
- Result of the CreateVPCConnection operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
createVPCConnection
default CreateVpcConnectionResponse createVPCConnection(Consumer<CreateVpcConnectionRequest.Builder> createVpcConnectionRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceExistsException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates a new VPC connection.
This is a convenience which creates an instance of the
CreateVpcConnectionRequest.Builderavoiding the need to create one manually viaCreateVpcConnectionRequest.builder()- Parameters:
createVpcConnectionRequest- AConsumerthat will call methods onCreateVpcConnectionRequest.Builderto create a request.- Returns:
- Result of the CreateVPCConnection operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAccountCustomPermission
default DeleteAccountCustomPermissionResponse deleteAccountCustomPermission(DeleteAccountCustomPermissionRequest deleteAccountCustomPermissionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Unapplies a custom permissions profile from an account.
- Parameters:
deleteAccountCustomPermissionRequest-- Returns:
- Result of the DeleteAccountCustomPermission operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAccountCustomPermission
default DeleteAccountCustomPermissionResponse deleteAccountCustomPermission(Consumer<DeleteAccountCustomPermissionRequest.Builder> deleteAccountCustomPermissionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Unapplies a custom permissions profile from an account.
This is a convenience which creates an instance of the
DeleteAccountCustomPermissionRequest.Builderavoiding the need to create one manually viaDeleteAccountCustomPermissionRequest.builder()- Parameters:
deleteAccountCustomPermissionRequest- AConsumerthat will call methods onDeleteAccountCustomPermissionRequest.Builderto create a request.- Returns:
- Result of the DeleteAccountCustomPermission operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAccountCustomization
default DeleteAccountCustomizationResponse deleteAccountCustomization(DeleteAccountCustomizationRequest deleteAccountCustomizationRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and QuickSight namespace.
- Parameters:
deleteAccountCustomizationRequest-- Returns:
- Result of the DeleteAccountCustomization operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAccountCustomization
default DeleteAccountCustomizationResponse deleteAccountCustomization(Consumer<DeleteAccountCustomizationRequest.Builder> deleteAccountCustomizationRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and QuickSight namespace.
This is a convenience which creates an instance of the
DeleteAccountCustomizationRequest.Builderavoiding the need to create one manually viaDeleteAccountCustomizationRequest.builder()- Parameters:
deleteAccountCustomizationRequest- AConsumerthat will call methods onDeleteAccountCustomizationRequest.Builderto create a request.- Returns:
- Result of the DeleteAccountCustomization operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAccountSubscription
default DeleteAccountSubscriptionResponse deleteAccountSubscription(DeleteAccountSubscriptionRequest deleteAccountSubscriptionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Use the
DeleteAccountSubscriptionoperation to delete an 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 theUpdateAccountSettingsAPI and set the value of theTerminationProtectionEnabledparameter toFalse, then make another call to theDeleteAccountSubscriptionAPI.- Parameters:
deleteAccountSubscriptionRequest-- Returns:
- Result of the DeleteAccountSubscription operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAccountSubscription
default DeleteAccountSubscriptionResponse deleteAccountSubscription(Consumer<DeleteAccountSubscriptionRequest.Builder> deleteAccountSubscriptionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Use the
DeleteAccountSubscriptionoperation to delete an 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 theUpdateAccountSettingsAPI and set the value of theTerminationProtectionEnabledparameter toFalse, then make another call to theDeleteAccountSubscriptionAPI.
This is a convenience which creates an instance of the
DeleteAccountSubscriptionRequest.Builderavoiding the need to create one manually viaDeleteAccountSubscriptionRequest.builder()- Parameters:
deleteAccountSubscriptionRequest- AConsumerthat will call methods onDeleteAccountSubscriptionRequest.Builderto create a request.- Returns:
- Result of the DeleteAccountSubscription operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAnalysis
default DeleteAnalysisResponse deleteAnalysis(DeleteAnalysisRequest deleteAnalysisRequest) throws ThrottlingException, InvalidParameterValueException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. QuickSight attaches a
DeletionTimestamp to the response that specifies the end of the recovery window. At the end of the recovery window, QuickSight deletes the analysis permanently.At any time before recovery window ends, you can use the
RestoreAnalysisAPI operation to remove theDeletionTimestamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it.An analysis that's scheduled for deletion isn't accessible in the QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
- Parameters:
deleteAnalysisRequest-- Returns:
- Result of the DeleteAnalysis operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAnalysis
default DeleteAnalysisResponse deleteAnalysis(Consumer<DeleteAnalysisRequest.Builder> deleteAnalysisRequest) throws ThrottlingException, InvalidParameterValueException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. QuickSight attaches a
DeletionTimestamp to the response that specifies the end of the recovery window. At the end of the recovery window, QuickSight deletes the analysis permanently.At any time before recovery window ends, you can use the
RestoreAnalysisAPI operation to remove theDeletionTimestamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it.An analysis that's scheduled for deletion isn't accessible in the 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.Builderavoiding the need to create one manually viaDeleteAnalysisRequest.builder()- Parameters:
deleteAnalysisRequest- AConsumerthat will call methods onDeleteAnalysisRequest.Builderto create a request.- Returns:
- Result of the DeleteAnalysis operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteBrand
default DeleteBrandResponse deleteBrand(DeleteBrandRequest deleteBrandRequest) throws ThrottlingException, InvalidRequestException, ResourceNotFoundException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, QuickSightException
Deletes an QuickSight brand.
- Parameters:
deleteBrandRequest-- Returns:
- Result of the DeleteBrand operation returned by the service.
- Throws:
ThrottlingException- Access is throttled.InvalidRequestException- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.ResourceNotFoundException- One or more resources can't be found.ConflictException- Updating or deleting a resource can cause an inconsistent state.AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.InternalServerException- An internal service exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteBrand
default DeleteBrandResponse deleteBrand(Consumer<DeleteBrandRequest.Builder> deleteBrandRequest) throws ThrottlingException, InvalidRequestException, ResourceNotFoundException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, QuickSightException
Deletes an QuickSight brand.
This is a convenience which creates an instance of the
DeleteBrandRequest.Builderavoiding the need to create one manually viaDeleteBrandRequest.builder()- Parameters:
deleteBrandRequest- AConsumerthat will call methods onDeleteBrandRequest.Builderto create a request.- Returns:
- Result of the DeleteBrand operation returned by the service.
- Throws:
ThrottlingException- Access is throttled.InvalidRequestException- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.ResourceNotFoundException- One or more resources can't be found.ConflictException- Updating or deleting a resource can cause an inconsistent state.AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.InternalServerException- An internal service exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteBrandAssignment
default DeleteBrandAssignmentResponse deleteBrandAssignment(DeleteBrandAssignmentRequest deleteBrandAssignmentRequest) throws ThrottlingException, InvalidRequestException, ResourceNotFoundException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, QuickSightException
Deletes a brand assignment.
- Parameters:
deleteBrandAssignmentRequest-- Returns:
- Result of the DeleteBrandAssignment operation returned by the service.
- Throws:
ThrottlingException- Access is throttled.InvalidRequestException- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.ResourceNotFoundException- One or more resources can't be found.ConflictException- Updating or deleting a resource can cause an inconsistent state.AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.InternalServerException- An internal service exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteBrandAssignment
default DeleteBrandAssignmentResponse deleteBrandAssignment(Consumer<DeleteBrandAssignmentRequest.Builder> deleteBrandAssignmentRequest) throws ThrottlingException, InvalidRequestException, ResourceNotFoundException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, QuickSightException
Deletes a brand assignment.
This is a convenience which creates an instance of the
DeleteBrandAssignmentRequest.Builderavoiding the need to create one manually viaDeleteBrandAssignmentRequest.builder()- Parameters:
deleteBrandAssignmentRequest- AConsumerthat will call methods onDeleteBrandAssignmentRequest.Builderto create a request.- Returns:
- Result of the DeleteBrandAssignment operation returned by the service.
- Throws:
ThrottlingException- Access is throttled.InvalidRequestException- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.ResourceNotFoundException- One or more resources can't be found.ConflictException- Updating or deleting a resource can cause an inconsistent state.AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.InternalServerException- An internal service exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteCustomPermissions
default DeleteCustomPermissionsResponse deleteCustomPermissions(DeleteCustomPermissionsRequest deleteCustomPermissionsRequest) throws ConflictException, AccessDeniedException, ResourceNotFoundException, ResourceExistsException, InvalidParameterValueException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Deletes a custom permissions profile.
- Parameters:
deleteCustomPermissionsRequest-- Returns:
- Result of the DeleteCustomPermissions operation returned by the service.
- Throws:
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.ResourceNotFoundException- One or more resources can't be found.ResourceExistsException- The resource specified already exists.InvalidParameterValueException- One or more parameters has a value that isn't valid.ThrottlingException- Access is throttled.PreconditionNotMetException- One or more preconditions aren't met.InternalFailureException- An internal failure occurred.ResourceUnavailableException- This resource is currently unavailable.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteCustomPermissions
default DeleteCustomPermissionsResponse deleteCustomPermissions(Consumer<DeleteCustomPermissionsRequest.Builder> deleteCustomPermissionsRequest) throws ConflictException, AccessDeniedException, ResourceNotFoundException, ResourceExistsException, InvalidParameterValueException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Deletes a custom permissions profile.
This is a convenience which creates an instance of the
DeleteCustomPermissionsRequest.Builderavoiding the need to create one manually viaDeleteCustomPermissionsRequest.builder()- Parameters:
deleteCustomPermissionsRequest- AConsumerthat will call methods onDeleteCustomPermissionsRequest.Builderto create a request.- Returns:
- Result of the DeleteCustomPermissions operation returned by the service.
- Throws:
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.ResourceNotFoundException- One or more resources can't be found.ResourceExistsException- The resource specified already exists.InvalidParameterValueException- One or more parameters has a value that isn't valid.ThrottlingException- Access is throttled.PreconditionNotMetException- One or more preconditions aren't met.InternalFailureException- An internal failure occurred.ResourceUnavailableException- This resource is currently unavailable.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDashboard
default DeleteDashboardResponse deleteDashboard(DeleteDashboardRequest deleteDashboardRequest) throws ThrottlingException, InvalidParameterValueException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a dashboard.
- Parameters:
deleteDashboardRequest-- Returns:
- Result of the DeleteDashboard operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDashboard
default DeleteDashboardResponse deleteDashboard(Consumer<DeleteDashboardRequest.Builder> deleteDashboardRequest) throws ThrottlingException, InvalidParameterValueException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a dashboard.
This is a convenience which creates an instance of the
DeleteDashboardRequest.Builderavoiding the need to create one manually viaDeleteDashboardRequest.builder()- Parameters:
deleteDashboardRequest- AConsumerthat will call methods onDeleteDashboardRequest.Builderto create a request.- Returns:
- Result of the DeleteDashboard operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDataSet
default DeleteDataSetResponse deleteDataSet(DeleteDataSetRequest deleteDataSetRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a dataset.
- Parameters:
deleteDataSetRequest-- Returns:
- Result of the DeleteDataSet operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDataSet
default DeleteDataSetResponse deleteDataSet(Consumer<DeleteDataSetRequest.Builder> deleteDataSetRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a dataset.
This is a convenience which creates an instance of the
DeleteDataSetRequest.Builderavoiding the need to create one manually viaDeleteDataSetRequest.builder()- Parameters:
deleteDataSetRequest- AConsumerthat will call methods onDeleteDataSetRequest.Builderto create a request.- Returns:
- Result of the DeleteDataSet operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDataSetRefreshProperties
default DeleteDataSetRefreshPropertiesResponse deleteDataSetRefreshProperties(DeleteDataSetRefreshPropertiesRequest deleteDataSetRefreshPropertiesRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, ConflictException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes the dataset refresh properties of the dataset.
- Parameters:
deleteDataSetRefreshPropertiesRequest-- Returns:
- Result of the DeleteDataSetRefreshProperties operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDataSetRefreshProperties
default DeleteDataSetRefreshPropertiesResponse deleteDataSetRefreshProperties(Consumer<DeleteDataSetRefreshPropertiesRequest.Builder> deleteDataSetRefreshPropertiesRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, ConflictException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes the dataset refresh properties of the dataset.
This is a convenience which creates an instance of the
DeleteDataSetRefreshPropertiesRequest.Builderavoiding the need to create one manually viaDeleteDataSetRefreshPropertiesRequest.builder()- Parameters:
deleteDataSetRefreshPropertiesRequest- AConsumerthat will call methods onDeleteDataSetRefreshPropertiesRequest.Builderto create a request.- Returns:
- Result of the DeleteDataSetRefreshProperties operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDataSource
default DeleteDataSourceResponse deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
- Parameters:
deleteDataSourceRequest-- Returns:
- Result of the DeleteDataSource operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDataSource
default DeleteDataSourceResponse deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
This is a convenience which creates an instance of the
DeleteDataSourceRequest.Builderavoiding the need to create one manually viaDeleteDataSourceRequest.builder()- Parameters:
deleteDataSourceRequest- AConsumerthat will call methods onDeleteDataSourceRequest.Builderto create a request.- Returns:
- Result of the DeleteDataSource operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDefaultQBusinessApplication
default DeleteDefaultQBusinessApplicationResponse deleteDefaultQBusinessApplication(DeleteDefaultQBusinessApplicationRequest deleteDefaultQBusinessApplicationRequest) throws AccessDeniedException, ConflictException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a linked Amazon Q Business application from an QuickSight account
- Parameters:
deleteDefaultQBusinessApplicationRequest-- Returns:
- Result of the DeleteDefaultQBusinessApplication operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDefaultQBusinessApplication
default DeleteDefaultQBusinessApplicationResponse deleteDefaultQBusinessApplication(Consumer<DeleteDefaultQBusinessApplicationRequest.Builder> deleteDefaultQBusinessApplicationRequest) throws AccessDeniedException, ConflictException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a linked Amazon Q Business application from an QuickSight account
This is a convenience which creates an instance of the
DeleteDefaultQBusinessApplicationRequest.Builderavoiding the need to create one manually viaDeleteDefaultQBusinessApplicationRequest.builder()- Parameters:
deleteDefaultQBusinessApplicationRequest- AConsumerthat will call methods onDeleteDefaultQBusinessApplicationRequest.Builderto create a request.- Returns:
- Result of the DeleteDefaultQBusinessApplication operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteFolder
default DeleteFolderResponse deleteFolder(DeleteFolderRequest deleteFolderRequest) throws InvalidParameterValueException, PreconditionNotMetException, AccessDeniedException, ResourceNotFoundException, ConflictException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes an empty folder.
- Parameters:
deleteFolderRequest-- Returns:
- Result of the DeleteFolder operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteFolder
default DeleteFolderResponse deleteFolder(Consumer<DeleteFolderRequest.Builder> deleteFolderRequest) throws InvalidParameterValueException, PreconditionNotMetException, AccessDeniedException, ResourceNotFoundException, ConflictException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes an empty folder.
This is a convenience which creates an instance of the
DeleteFolderRequest.Builderavoiding the need to create one manually viaDeleteFolderRequest.builder()- Parameters:
deleteFolderRequest- AConsumerthat will call methods onDeleteFolderRequest.Builderto create a request.- Returns:
- Result of the DeleteFolder operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteFolderMembership
default DeleteFolderMembershipResponse deleteFolderMembership(DeleteFolderMembershipRequest deleteFolderMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
- Parameters:
deleteFolderMembershipRequest-- Returns:
- Result of the DeleteFolderMembership operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteFolderMembership
default DeleteFolderMembershipResponse deleteFolderMembership(Consumer<DeleteFolderMembershipRequest.Builder> deleteFolderMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
This is a convenience which creates an instance of the
DeleteFolderMembershipRequest.Builderavoiding the need to create one manually viaDeleteFolderMembershipRequest.builder()- Parameters:
deleteFolderMembershipRequest- AConsumerthat will call methods onDeleteFolderMembershipRequest.Builderto create a request.- Returns:
- Result of the DeleteFolderMembership operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteGroup
default DeleteGroupResponse deleteGroup(DeleteGroupRequest deleteGroupRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Removes a user group from Amazon QuickSight.
- Parameters:
deleteGroupRequest-- Returns:
- Result of the DeleteGroup operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteGroup
default DeleteGroupResponse deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Removes a user group from Amazon QuickSight.
This is a convenience which creates an instance of the
DeleteGroupRequest.Builderavoiding the need to create one manually viaDeleteGroupRequest.builder()- Parameters:
deleteGroupRequest- AConsumerthat will call methods onDeleteGroupRequest.Builderto create a request.- Returns:
- Result of the DeleteGroup operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteGroupMembership
default DeleteGroupMembershipResponse deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Removes a user from a group so that the user is no longer a member of the group.
- Parameters:
deleteGroupMembershipRequest-- Returns:
- Result of the DeleteGroupMembership operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteGroupMembership
default DeleteGroupMembershipResponse deleteGroupMembership(Consumer<DeleteGroupMembershipRequest.Builder> deleteGroupMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Removes a user from a group so that the user is no longer a member of the group.
This is a convenience which creates an instance of the
DeleteGroupMembershipRequest.Builderavoiding the need to create one manually viaDeleteGroupMembershipRequest.builder()- Parameters:
deleteGroupMembershipRequest- AConsumerthat will call methods onDeleteGroupMembershipRequest.Builderto create a request.- Returns:
- Result of the DeleteGroupMembership operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteIAMPolicyAssignment
default DeleteIamPolicyAssignmentResponse deleteIAMPolicyAssignment(DeleteIamPolicyAssignmentRequest deleteIamPolicyAssignmentRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConcurrentUpdatingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes an existing IAM policy assignment.
- Parameters:
deleteIamPolicyAssignmentRequest-- Returns:
- Result of the DeleteIAMPolicyAssignment operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteIAMPolicyAssignment
default DeleteIamPolicyAssignmentResponse deleteIAMPolicyAssignment(Consumer<DeleteIamPolicyAssignmentRequest.Builder> deleteIamPolicyAssignmentRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConcurrentUpdatingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes an existing IAM policy assignment.
This is a convenience which creates an instance of the
DeleteIamPolicyAssignmentRequest.Builderavoiding the need to create one manually viaDeleteIamPolicyAssignmentRequest.builder()- Parameters:
deleteIamPolicyAssignmentRequest- AConsumerthat will call methods onDeleteIamPolicyAssignmentRequest.Builderto create a request.- Returns:
- Result of the DeleteIAMPolicyAssignment operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteIdentityPropagationConfig
default DeleteIdentityPropagationConfigResponse deleteIdentityPropagationConfig(DeleteIdentityPropagationConfigRequest deleteIdentityPropagationConfigRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes all access scopes and authorized targets that are associated with a service from the QuickSight IAM Identity Center application.
This operation is only supported for QuickSight accounts that use IAM Identity Center.
- Parameters:
deleteIdentityPropagationConfigRequest-- Returns:
- Result of the DeleteIdentityPropagationConfig operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteIdentityPropagationConfig
default DeleteIdentityPropagationConfigResponse deleteIdentityPropagationConfig(Consumer<DeleteIdentityPropagationConfigRequest.Builder> deleteIdentityPropagationConfigRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes all access scopes and authorized targets that are associated with a service from the QuickSight IAM Identity Center application.
This operation is only supported for QuickSight accounts that use IAM Identity Center.
This is a convenience which creates an instance of the
DeleteIdentityPropagationConfigRequest.Builderavoiding the need to create one manually viaDeleteIdentityPropagationConfigRequest.builder()- Parameters:
deleteIdentityPropagationConfigRequest- AConsumerthat will call methods onDeleteIdentityPropagationConfigRequest.Builderto create a request.- Returns:
- Result of the DeleteIdentityPropagationConfig operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteNamespace
default DeleteNamespaceResponse deleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.
- Parameters:
deleteNamespaceRequest-- Returns:
- Result of the DeleteNamespace operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteNamespace
default DeleteNamespaceResponse deleteNamespace(Consumer<DeleteNamespaceRequest.Builder> deleteNamespaceRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.
This is a convenience which creates an instance of the
DeleteNamespaceRequest.Builderavoiding the need to create one manually viaDeleteNamespaceRequest.builder()- Parameters:
deleteNamespaceRequest- AConsumerthat will call methods onDeleteNamespaceRequest.Builderto create a request.- Returns:
- Result of the DeleteNamespace operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRefreshSchedule
default DeleteRefreshScheduleResponse deleteRefreshSchedule(DeleteRefreshScheduleRequest deleteRefreshScheduleRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a refresh schedule from a dataset.
- Parameters:
deleteRefreshScheduleRequest-- Returns:
- Result of the DeleteRefreshSchedule operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRefreshSchedule
default DeleteRefreshScheduleResponse deleteRefreshSchedule(Consumer<DeleteRefreshScheduleRequest.Builder> deleteRefreshScheduleRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a refresh schedule from a dataset.
This is a convenience which creates an instance of the
DeleteRefreshScheduleRequest.Builderavoiding the need to create one manually viaDeleteRefreshScheduleRequest.builder()- Parameters:
deleteRefreshScheduleRequest- AConsumerthat will call methods onDeleteRefreshScheduleRequest.Builderto create a request.- Returns:
- Result of the DeleteRefreshSchedule operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRoleCustomPermission
default DeleteRoleCustomPermissionResponse deleteRoleCustomPermission(DeleteRoleCustomPermissionRequest deleteRoleCustomPermissionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Removes custom permissions from the role.
- Parameters:
deleteRoleCustomPermissionRequest-- Returns:
- Result of the DeleteRoleCustomPermission operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRoleCustomPermission
default DeleteRoleCustomPermissionResponse deleteRoleCustomPermission(Consumer<DeleteRoleCustomPermissionRequest.Builder> deleteRoleCustomPermissionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Removes custom permissions from the role.
This is a convenience which creates an instance of the
DeleteRoleCustomPermissionRequest.Builderavoiding the need to create one manually viaDeleteRoleCustomPermissionRequest.builder()- Parameters:
deleteRoleCustomPermissionRequest- AConsumerthat will call methods onDeleteRoleCustomPermissionRequest.Builderto create a request.- Returns:
- Result of the DeleteRoleCustomPermission operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRoleMembership
default DeleteRoleMembershipResponse deleteRoleMembership(DeleteRoleMembershipRequest deleteRoleMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Removes a group from a role.
- Parameters:
deleteRoleMembershipRequest-- Returns:
- Result of the DeleteRoleMembership operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRoleMembership
default DeleteRoleMembershipResponse deleteRoleMembership(Consumer<DeleteRoleMembershipRequest.Builder> deleteRoleMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Removes a group from a role.
This is a convenience which creates an instance of the
DeleteRoleMembershipRequest.Builderavoiding the need to create one manually viaDeleteRoleMembershipRequest.builder()- Parameters:
deleteRoleMembershipRequest- AConsumerthat will call methods onDeleteRoleMembershipRequest.Builderto create a request.- Returns:
- Result of the DeleteRoleMembership operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTemplate
default DeleteTemplateResponse deleteTemplate(DeleteTemplateRequest deleteTemplateRequest) throws InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ConflictException, LimitExceededException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a template.
- Parameters:
deleteTemplateRequest-- Returns:
- Result of the DeleteTemplate operation returned by the service.
- Throws:
InvalidParameterValueException- 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTemplate
default DeleteTemplateResponse deleteTemplate(Consumer<DeleteTemplateRequest.Builder> deleteTemplateRequest) throws InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ConflictException, LimitExceededException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a template.
This is a convenience which creates an instance of the
DeleteTemplateRequest.Builderavoiding the need to create one manually viaDeleteTemplateRequest.builder()- Parameters:
deleteTemplateRequest- AConsumerthat will call methods onDeleteTemplateRequest.Builderto create a request.- Returns:
- Result of the DeleteTemplate operation returned by the service.
- Throws:
InvalidParameterValueException- 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTemplateAlias
default DeleteTemplateAliasResponse deleteTemplateAlias(DeleteTemplateAliasRequest deleteTemplateAliasRequest) throws ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, ConflictException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
- Parameters:
deleteTemplateAliasRequest-- Returns:
- Result of the DeleteTemplateAlias operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTemplateAlias
default DeleteTemplateAliasResponse deleteTemplateAlias(Consumer<DeleteTemplateAliasRequest.Builder> deleteTemplateAliasRequest) throws ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, ConflictException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
This is a convenience which creates an instance of the
DeleteTemplateAliasRequest.Builderavoiding the need to create one manually viaDeleteTemplateAliasRequest.builder()- Parameters:
deleteTemplateAliasRequest- AConsumerthat will call methods onDeleteTemplateAliasRequest.Builderto create a request.- Returns:
- Result of the DeleteTemplateAlias operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTheme
default DeleteThemeResponse deleteTheme(DeleteThemeRequest deleteThemeRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a theme.
- Parameters:
deleteThemeRequest-- Returns:
- Result of the DeleteTheme operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTheme
default DeleteThemeResponse deleteTheme(Consumer<DeleteThemeRequest.Builder> deleteThemeRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a theme.
This is a convenience which creates an instance of the
DeleteThemeRequest.Builderavoiding the need to create one manually viaDeleteThemeRequest.builder()- Parameters:
deleteThemeRequest- AConsumerthat will call methods onDeleteThemeRequest.Builderto create a request.- Returns:
- Result of the DeleteTheme operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteThemeAlias
default DeleteThemeAliasResponse deleteThemeAlias(DeleteThemeAliasRequest deleteThemeAliasRequest) throws ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.
- Parameters:
deleteThemeAliasRequest-- Returns:
- Result of the DeleteThemeAlias operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteThemeAlias
default DeleteThemeAliasResponse deleteThemeAlias(Consumer<DeleteThemeAliasRequest.Builder> deleteThemeAliasRequest) throws ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.
This is a convenience which creates an instance of the
DeleteThemeAliasRequest.Builderavoiding the need to create one manually viaDeleteThemeAliasRequest.builder()- Parameters:
deleteThemeAliasRequest- AConsumerthat will call methods onDeleteThemeAliasRequest.Builderto create a request.- Returns:
- Result of the DeleteThemeAlias operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTopic
default DeleteTopicResponse deleteTopic(DeleteTopicRequest deleteTopicRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, ConflictException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a topic.
- Parameters:
deleteTopicRequest-- Returns:
- Result of the DeleteTopic operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTopic
default DeleteTopicResponse deleteTopic(Consumer<DeleteTopicRequest.Builder> deleteTopicRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, ConflictException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a topic.
This is a convenience which creates an instance of the
DeleteTopicRequest.Builderavoiding the need to create one manually viaDeleteTopicRequest.builder()- Parameters:
deleteTopicRequest- AConsumerthat will call methods onDeleteTopicRequest.Builderto create a request.- Returns:
- Result of the DeleteTopic operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTopicRefreshSchedule
default DeleteTopicRefreshScheduleResponse deleteTopicRefreshSchedule(DeleteTopicRefreshScheduleRequest deleteTopicRefreshScheduleRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceNotFoundException, ResourceExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a topic refresh schedule.
- Parameters:
deleteTopicRefreshScheduleRequest-- Returns:
- Result of the DeleteTopicRefreshSchedule operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTopicRefreshSchedule
default DeleteTopicRefreshScheduleResponse deleteTopicRefreshSchedule(Consumer<DeleteTopicRefreshScheduleRequest.Builder> deleteTopicRefreshScheduleRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceNotFoundException, ResourceExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a topic refresh schedule.
This is a convenience which creates an instance of the
DeleteTopicRefreshScheduleRequest.Builderavoiding the need to create one manually viaDeleteTopicRefreshScheduleRequest.builder()- Parameters:
deleteTopicRefreshScheduleRequest- AConsumerthat will call methods onDeleteTopicRefreshScheduleRequest.Builderto create a request.- Returns:
- Result of the DeleteTopicRefreshSchedule operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteUser
default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Deletes the Amazon QuickSight user that is associated with the identity of the IAM user or role that's making the call. The IAM user isn't deleted as a result of this call.
- Parameters:
deleteUserRequest-- Returns:
- Result of the DeleteUser operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteUser
default DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Deletes the Amazon QuickSight user that is associated with the identity of the IAM user or role that's making the call. The IAM user isn't deleted as a result of this call.
This is a convenience which creates an instance of the
DeleteUserRequest.Builderavoiding the need to create one manually viaDeleteUserRequest.builder()- Parameters:
deleteUserRequest- AConsumerthat will call methods onDeleteUserRequest.Builderto create a request.- Returns:
- Result of the DeleteUser operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteUserByPrincipalId
default DeleteUserByPrincipalIdResponse deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest deleteUserByPrincipalIdRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Deletes a user identified by its principal ID.
- Parameters:
deleteUserByPrincipalIdRequest-- Returns:
- Result of the DeleteUserByPrincipalId operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteUserByPrincipalId
default DeleteUserByPrincipalIdResponse deleteUserByPrincipalId(Consumer<DeleteUserByPrincipalIdRequest.Builder> deleteUserByPrincipalIdRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Deletes a user identified by its principal ID.
This is a convenience which creates an instance of the
DeleteUserByPrincipalIdRequest.Builderavoiding the need to create one manually viaDeleteUserByPrincipalIdRequest.builder()- Parameters:
deleteUserByPrincipalIdRequest- AConsumerthat will call methods onDeleteUserByPrincipalIdRequest.Builderto create a request.- Returns:
- Result of the DeleteUserByPrincipalId operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteUserCustomPermission
default DeleteUserCustomPermissionResponse deleteUserCustomPermission(DeleteUserCustomPermissionRequest deleteUserCustomPermissionRequest) throws ConflictException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Deletes a custom permissions profile from a user.
- Parameters:
deleteUserCustomPermissionRequest-- Returns:
- Result of the DeleteUserCustomPermission operation returned by the service.
- Throws:
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.InvalidParameterValueException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteUserCustomPermission
default DeleteUserCustomPermissionResponse deleteUserCustomPermission(Consumer<DeleteUserCustomPermissionRequest.Builder> deleteUserCustomPermissionRequest) throws ConflictException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Deletes a custom permissions profile from a user.
This is a convenience which creates an instance of the
DeleteUserCustomPermissionRequest.Builderavoiding the need to create one manually viaDeleteUserCustomPermissionRequest.builder()- Parameters:
deleteUserCustomPermissionRequest- AConsumerthat will call methods onDeleteUserCustomPermissionRequest.Builderto create a request.- Returns:
- Result of the DeleteUserCustomPermission operation returned by the service.
- Throws:
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.InvalidParameterValueException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteVPCConnection
default DeleteVpcConnectionResponse deleteVPCConnection(DeleteVpcConnectionRequest deleteVpcConnectionRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a VPC connection.
- Parameters:
deleteVpcConnectionRequest-- Returns:
- Result of the DeleteVPCConnection operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteVPCConnection
default DeleteVpcConnectionResponse deleteVPCConnection(Consumer<DeleteVpcConnectionRequest.Builder> deleteVpcConnectionRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a VPC connection.
This is a convenience which creates an instance of the
DeleteVpcConnectionRequest.Builderavoiding the need to create one manually viaDeleteVpcConnectionRequest.builder()- Parameters:
deleteVpcConnectionRequest- AConsumerthat will call methods onDeleteVpcConnectionRequest.Builderto create a request.- Returns:
- Result of the DeleteVPCConnection operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAccountCustomPermission
default DescribeAccountCustomPermissionResponse describeAccountCustomPermission(DescribeAccountCustomPermissionRequest describeAccountCustomPermissionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the custom permissions profile that is applied to an account.
- Parameters:
describeAccountCustomPermissionRequest-- Returns:
- Result of the DescribeAccountCustomPermission operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAccountCustomPermission
default DescribeAccountCustomPermissionResponse describeAccountCustomPermission(Consumer<DescribeAccountCustomPermissionRequest.Builder> describeAccountCustomPermissionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the custom permissions profile that is applied to an account.
This is a convenience which creates an instance of the
DescribeAccountCustomPermissionRequest.Builderavoiding the need to create one manually viaDescribeAccountCustomPermissionRequest.builder()- Parameters:
describeAccountCustomPermissionRequest- AConsumerthat will call methods onDescribeAccountCustomPermissionRequest.Builderto create a request.- Returns:
- Result of the DescribeAccountCustomPermission operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAccountCustomization
default DescribeAccountCustomizationResponse describeAccountCustomization(DescribeAccountCustomizationRequest describeAccountCustomizationRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Describes the customizations associated with the provided Amazon Web Services account and Amazon QuickSight namespace in an Amazon Web Services Region. The QuickSight console evaluates which customizations to apply by running this API operation with the
Resolvedflag included.To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.
-
Amazon Web Services account- The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you subscribe to 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 QuickSight in any supported Amazon Web Services Region. -
Amazon Web Services Region- In each Amazon Web Services Region where you sign in to QuickSight at least once, 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 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 configureto change your default Amazon Web Services Region. Use Enter to key the same settings for your keys. For more information, see Configuring the CLI.
-
-
Namespace- A 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 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 theCreateAccountCustomizationcommand in each Amazon Web Services Region where you want to apply the same customizations.
- Parameters:
describeAccountCustomizationRequest-- Returns:
- Result of the DescribeAccountCustomization operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeAccountCustomization
default DescribeAccountCustomizationResponse describeAccountCustomization(Consumer<DescribeAccountCustomizationRequest.Builder> describeAccountCustomizationRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Describes the customizations associated with the provided Amazon Web Services account and Amazon QuickSight namespace in an Amazon Web Services Region. The QuickSight console evaluates which customizations to apply by running this API operation with the
Resolvedflag included.To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.
-
Amazon Web Services account- The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you subscribe to 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 QuickSight in any supported Amazon Web Services Region. -
Amazon Web Services Region- In each Amazon Web Services Region where you sign in to QuickSight at least once, 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 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 configureto change your default Amazon Web Services Region. Use Enter to key the same settings for your keys. For more information, see Configuring the CLI.
-
-
Namespace- A 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 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 theCreateAccountCustomizationcommand 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.Builderavoiding the need to create one manually viaDescribeAccountCustomizationRequest.builder()- Parameters:
describeAccountCustomizationRequest- AConsumerthat will call methods onDescribeAccountCustomizationRequest.Builderto create a request.- Returns:
- Result of the DescribeAccountCustomization operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeAccountSettings
default DescribeAccountSettingsResponse describeAccountSettings(DescribeAccountSettingsRequest describeAccountSettingsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Describes the settings that were used when your QuickSight subscription was first created in this Amazon Web Services account.
- Parameters:
describeAccountSettingsRequest-- Returns:
- Result of the DescribeAccountSettings operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAccountSettings
default DescribeAccountSettingsResponse describeAccountSettings(Consumer<DescribeAccountSettingsRequest.Builder> describeAccountSettingsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Describes the settings that were used when your QuickSight subscription was first created in this Amazon Web Services account.
This is a convenience which creates an instance of the
DescribeAccountSettingsRequest.Builderavoiding the need to create one manually viaDescribeAccountSettingsRequest.builder()- Parameters:
describeAccountSettingsRequest- AConsumerthat will call methods onDescribeAccountSettingsRequest.Builderto create a request.- Returns:
- Result of the DescribeAccountSettings operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAccountSubscription
default DescribeAccountSubscriptionResponse describeAccountSubscription(DescribeAccountSubscriptionRequest describeAccountSubscriptionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Use the DescribeAccountSubscription operation to receive a description of an QuickSight account's subscription. A successful API call returns an
AccountInfoobject that includes an account's name, subscription status, authentication type, edition, and notification email address.- Parameters:
describeAccountSubscriptionRequest-- Returns:
- Result of the DescribeAccountSubscription operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAccountSubscription
default DescribeAccountSubscriptionResponse describeAccountSubscription(Consumer<DescribeAccountSubscriptionRequest.Builder> describeAccountSubscriptionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Use the DescribeAccountSubscription operation to receive a description of an QuickSight account's subscription. A successful API call returns an
AccountInfoobject that includes an account's name, subscription status, authentication type, edition, and notification email address.
This is a convenience which creates an instance of the
DescribeAccountSubscriptionRequest.Builderavoiding the need to create one manually viaDescribeAccountSubscriptionRequest.builder()- Parameters:
describeAccountSubscriptionRequest- AConsumerthat will call methods onDescribeAccountSubscriptionRequest.Builderto create a request.- Returns:
- Result of the DescribeAccountSubscription operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAnalysis
default DescribeAnalysisResponse describeAnalysis(DescribeAnalysisRequest describeAnalysisRequest) throws InvalidParameterValueException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides a summary of the metadata for an analysis.
- Parameters:
describeAnalysisRequest-- Returns:
- Result of the DescribeAnalysis operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAnalysis
default DescribeAnalysisResponse describeAnalysis(Consumer<DescribeAnalysisRequest.Builder> describeAnalysisRequest) throws InvalidParameterValueException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides a summary of the metadata for an analysis.
This is a convenience which creates an instance of the
DescribeAnalysisRequest.Builderavoiding the need to create one manually viaDescribeAnalysisRequest.builder()- Parameters:
describeAnalysisRequest- AConsumerthat will call methods onDescribeAnalysisRequest.Builderto create a request.- Returns:
- Result of the DescribeAnalysis operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAnalysisDefinition
default DescribeAnalysisDefinitionResponse describeAnalysisDefinition(DescribeAnalysisDefinitionRequest describeAnalysisDefinitionRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides a detailed description of the definition of an analysis.
If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the
DescribeAnalysisinstead.- Parameters:
describeAnalysisDefinitionRequest-- Returns:
- Result of the DescribeAnalysisDefinition operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAnalysisDefinition
default DescribeAnalysisDefinitionResponse describeAnalysisDefinition(Consumer<DescribeAnalysisDefinitionRequest.Builder> describeAnalysisDefinitionRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides a detailed description of the definition of an analysis.
If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the
DescribeAnalysisinstead.
This is a convenience which creates an instance of the
DescribeAnalysisDefinitionRequest.Builderavoiding the need to create one manually viaDescribeAnalysisDefinitionRequest.builder()- Parameters:
describeAnalysisDefinitionRequest- AConsumerthat will call methods onDescribeAnalysisDefinitionRequest.Builderto create a request.- Returns:
- Result of the DescribeAnalysisDefinition operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAnalysisPermissions
default DescribeAnalysisPermissionsResponse describeAnalysisPermissions(DescribeAnalysisPermissionsRequest describeAnalysisPermissionsRequest) throws InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides the read and write permissions for an analysis.
- Parameters:
describeAnalysisPermissionsRequest-- Returns:
- Result of the DescribeAnalysisPermissions operation returned by the service.
- Throws:
InvalidParameterValueException- 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAnalysisPermissions
default DescribeAnalysisPermissionsResponse describeAnalysisPermissions(Consumer<DescribeAnalysisPermissionsRequest.Builder> describeAnalysisPermissionsRequest) throws InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides the read and write permissions for an analysis.
This is a convenience which creates an instance of the
DescribeAnalysisPermissionsRequest.Builderavoiding the need to create one manually viaDescribeAnalysisPermissionsRequest.builder()- Parameters:
describeAnalysisPermissionsRequest- AConsumerthat will call methods onDescribeAnalysisPermissionsRequest.Builderto create a request.- Returns:
- Result of the DescribeAnalysisPermissions operation returned by the service.
- Throws:
InvalidParameterValueException- 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAssetBundleExportJob
default DescribeAssetBundleExportJobResponse describeAssetBundleExportJob(DescribeAssetBundleExportJobRequest describeAssetBundleExportJobRequest) throws UnsupportedUserEditionException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QuickSightException
Describes an existing export job.
Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the
DescribeAssetBundleExportJobAPI for a new download URL as needed.Job descriptions are available for 14 days after the job starts.
- Parameters:
describeAssetBundleExportJobRequest-- Returns:
- Result of the DescribeAssetBundleExportJob operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAssetBundleExportJob
default DescribeAssetBundleExportJobResponse describeAssetBundleExportJob(Consumer<DescribeAssetBundleExportJobRequest.Builder> describeAssetBundleExportJobRequest) throws UnsupportedUserEditionException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QuickSightException
Describes an existing export job.
Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the
DescribeAssetBundleExportJobAPI for a new download URL as needed.Job descriptions are available for 14 days after the job starts.
This is a convenience which creates an instance of the
DescribeAssetBundleExportJobRequest.Builderavoiding the need to create one manually viaDescribeAssetBundleExportJobRequest.builder()- Parameters:
describeAssetBundleExportJobRequest- AConsumerthat will call methods onDescribeAssetBundleExportJobRequest.Builderto create a request.- Returns:
- Result of the DescribeAssetBundleExportJob operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAssetBundleImportJob
default DescribeAssetBundleImportJobResponse describeAssetBundleImportJob(DescribeAssetBundleImportJobRequest describeAssetBundleImportJobRequest) throws UnsupportedUserEditionException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QuickSightException
Describes an existing import job.
Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.
- Parameters:
describeAssetBundleImportJobRequest-- Returns:
- Result of the DescribeAssetBundleImportJob operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeAssetBundleImportJob
default DescribeAssetBundleImportJobResponse describeAssetBundleImportJob(Consumer<DescribeAssetBundleImportJobRequest.Builder> describeAssetBundleImportJobRequest) throws UnsupportedUserEditionException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QuickSightException
Describes an existing import job.
Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.
This is a convenience which creates an instance of the
DescribeAssetBundleImportJobRequest.Builderavoiding the need to create one manually viaDescribeAssetBundleImportJobRequest.builder()- Parameters:
describeAssetBundleImportJobRequest- AConsumerthat will call methods onDescribeAssetBundleImportJobRequest.Builderto create a request.- Returns:
- Result of the DescribeAssetBundleImportJob operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeBrand
default DescribeBrandResponse describeBrand(DescribeBrandRequest describeBrandRequest) throws ThrottlingException, InvalidRequestException, ResourceNotFoundException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, QuickSightException
Describes a brand.
- Parameters:
describeBrandRequest-- Returns:
- Result of the DescribeBrand operation returned by the service.
- Throws:
ThrottlingException- Access is throttled.InvalidRequestException- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.ResourceNotFoundException- One or more resources can't be found.ConflictException- Updating or deleting a resource can cause an inconsistent state.AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.InternalServerException- An internal service exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeBrand
default DescribeBrandResponse describeBrand(Consumer<DescribeBrandRequest.Builder> describeBrandRequest) throws ThrottlingException, InvalidRequestException, ResourceNotFoundException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, QuickSightException
Describes a brand.
This is a convenience which creates an instance of the
DescribeBrandRequest.Builderavoiding the need to create one manually viaDescribeBrandRequest.builder()- Parameters:
describeBrandRequest- AConsumerthat will call methods onDescribeBrandRequest.Builderto create a request.- Returns:
- Result of the DescribeBrand operation returned by the service.
- Throws:
ThrottlingException- Access is throttled.InvalidRequestException- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.ResourceNotFoundException- One or more resources can't be found.ConflictException- Updating or deleting a resource can cause an inconsistent state.AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.InternalServerException- An internal service exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeBrandAssignment
default DescribeBrandAssignmentResponse describeBrandAssignment(DescribeBrandAssignmentRequest describeBrandAssignmentRequest) throws ThrottlingException, InvalidRequestException, ResourceNotFoundException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, QuickSightException
Describes a brand assignment.
- Parameters:
describeBrandAssignmentRequest-- Returns:
- Result of the DescribeBrandAssignment operation returned by the service.
- Throws:
ThrottlingException- Access is throttled.InvalidRequestException- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.ResourceNotFoundException- One or more resources can't be found.ConflictException- Updating or deleting a resource can cause an inconsistent state.AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.InternalServerException- An internal service exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeBrandAssignment
default DescribeBrandAssignmentResponse describeBrandAssignment(Consumer<DescribeBrandAssignmentRequest.Builder> describeBrandAssignmentRequest) throws ThrottlingException, InvalidRequestException, ResourceNotFoundException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, QuickSightException
Describes a brand assignment.
This is a convenience which creates an instance of the
DescribeBrandAssignmentRequest.Builderavoiding the need to create one manually viaDescribeBrandAssignmentRequest.builder()- Parameters:
describeBrandAssignmentRequest- AConsumerthat will call methods onDescribeBrandAssignmentRequest.Builderto create a request.- Returns:
- Result of the DescribeBrandAssignment operation returned by the service.
- Throws:
ThrottlingException- Access is throttled.InvalidRequestException- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.ResourceNotFoundException- One or more resources can't be found.ConflictException- Updating or deleting a resource can cause an inconsistent state.AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.InternalServerException- An internal service exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeBrandPublishedVersion
default DescribeBrandPublishedVersionResponse describeBrandPublishedVersion(DescribeBrandPublishedVersionRequest describeBrandPublishedVersionRequest) throws ThrottlingException, InvalidRequestException, ResourceNotFoundException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, QuickSightException
Describes the published version of the brand.
- Parameters:
describeBrandPublishedVersionRequest-- Returns:
- Result of the DescribeBrandPublishedVersion operation returned by the service.
- Throws:
ThrottlingException- Access is throttled.InvalidRequestException- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.ResourceNotFoundException- One or more resources can't be found.ConflictException- Updating or deleting a resource can cause an inconsistent state.AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.InternalServerException- An internal service exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeBrandPublishedVersion
default DescribeBrandPublishedVersionResponse describeBrandPublishedVersion(Consumer<DescribeBrandPublishedVersionRequest.Builder> describeBrandPublishedVersionRequest) throws ThrottlingException, InvalidRequestException, ResourceNotFoundException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, QuickSightException
Describes the published version of the brand.
This is a convenience which creates an instance of the
DescribeBrandPublishedVersionRequest.Builderavoiding the need to create one manually viaDescribeBrandPublishedVersionRequest.builder()- Parameters:
describeBrandPublishedVersionRequest- AConsumerthat will call methods onDescribeBrandPublishedVersionRequest.Builderto create a request.- Returns:
- Result of the DescribeBrandPublishedVersion operation returned by the service.
- Throws:
ThrottlingException- Access is throttled.InvalidRequestException- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.ResourceNotFoundException- One or more resources can't be found.ConflictException- Updating or deleting a resource can cause an inconsistent state.AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.InternalServerException- An internal service exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeCustomPermissions
default DescribeCustomPermissionsResponse describeCustomPermissions(DescribeCustomPermissionsRequest describeCustomPermissionsRequest) throws AccessDeniedException, ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Describes a custom permissions profile.
- Parameters:
describeCustomPermissionsRequest-- Returns:
- Result of the DescribeCustomPermissions operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.InvalidParameterValueException- One or more parameters has a value that isn't valid.ThrottlingException- Access is throttled.PreconditionNotMetException- One or more preconditions aren't met.InternalFailureException- An internal failure occurred.ResourceUnavailableException- This resource is currently unavailable.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeCustomPermissions
default DescribeCustomPermissionsResponse describeCustomPermissions(Consumer<DescribeCustomPermissionsRequest.Builder> describeCustomPermissionsRequest) throws AccessDeniedException, ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Describes a custom permissions profile.
This is a convenience which creates an instance of the
DescribeCustomPermissionsRequest.Builderavoiding the need to create one manually viaDescribeCustomPermissionsRequest.builder()- Parameters:
describeCustomPermissionsRequest- AConsumerthat will call methods onDescribeCustomPermissionsRequest.Builderto create a request.- Returns:
- Result of the DescribeCustomPermissions operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.InvalidParameterValueException- One or more parameters has a value that isn't valid.ThrottlingException- Access is throttled.PreconditionNotMetException- One or more preconditions aren't met.InternalFailureException- An internal failure occurred.ResourceUnavailableException- This resource is currently unavailable.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDashboard
default DescribeDashboardResponse describeDashboard(DescribeDashboardRequest describeDashboardRequest) throws InvalidParameterValueException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides a summary for a dashboard.
- Parameters:
describeDashboardRequest-- Returns:
- Result of the DescribeDashboard operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDashboard
default DescribeDashboardResponse describeDashboard(Consumer<DescribeDashboardRequest.Builder> describeDashboardRequest) throws InvalidParameterValueException, ResourceNotFoundException, AccessDeniedException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides a summary for a dashboard.
This is a convenience which creates an instance of the
DescribeDashboardRequest.Builderavoiding the need to create one manually viaDescribeDashboardRequest.builder()- Parameters:
describeDashboardRequest- AConsumerthat will call methods onDescribeDashboardRequest.Builderto create a request.- Returns:
- Result of the DescribeDashboard operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDashboardDefinition
default DescribeDashboardDefinitionResponse describeDashboardDefinition(DescribeDashboardDefinitionRequest describeDashboardDefinitionRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides a detailed description of the definition of a dashboard.
If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the
DescribeDashboardinstead.- Parameters:
describeDashboardDefinitionRequest-- Returns:
- Result of the DescribeDashboardDefinition operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDashboardDefinition
default DescribeDashboardDefinitionResponse describeDashboardDefinition(Consumer<DescribeDashboardDefinitionRequest.Builder> describeDashboardDefinitionRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides a detailed description of the definition of a dashboard.
If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the
DescribeDashboardinstead.
This is a convenience which creates an instance of the
DescribeDashboardDefinitionRequest.Builderavoiding the need to create one manually viaDescribeDashboardDefinitionRequest.builder()- Parameters:
describeDashboardDefinitionRequest- AConsumerthat will call methods onDescribeDashboardDefinitionRequest.Builderto create a request.- Returns:
- Result of the DescribeDashboardDefinition operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDashboardPermissions
default DescribeDashboardPermissionsResponse describeDashboardPermissions(DescribeDashboardPermissionsRequest describeDashboardPermissionsRequest) throws InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes read and write permissions for a dashboard.
- Parameters:
describeDashboardPermissionsRequest-- Returns:
- Result of the DescribeDashboardPermissions operation returned by the service.
- Throws:
InvalidParameterValueException- 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDashboardPermissions
default DescribeDashboardPermissionsResponse describeDashboardPermissions(Consumer<DescribeDashboardPermissionsRequest.Builder> describeDashboardPermissionsRequest) throws InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes read and write permissions for a dashboard.
This is a convenience which creates an instance of the
DescribeDashboardPermissionsRequest.Builderavoiding the need to create one manually viaDescribeDashboardPermissionsRequest.builder()- Parameters:
describeDashboardPermissionsRequest- AConsumerthat will call methods onDescribeDashboardPermissionsRequest.Builderto create a request.- Returns:
- Result of the DescribeDashboardPermissions operation returned by the service.
- Throws:
InvalidParameterValueException- 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDashboardSnapshotJob
default DescribeDashboardSnapshotJobResponse describeDashboardSnapshotJob(DescribeDashboardSnapshotJobRequest describeDashboardSnapshotJobRequest) throws AccessDeniedException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes an existing snapshot job.
Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see
JobStatus.- Parameters:
describeDashboardSnapshotJobRequest-- Returns:
- Result of the DescribeDashboardSnapshotJob operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDashboardSnapshotJob
default DescribeDashboardSnapshotJobResponse describeDashboardSnapshotJob(Consumer<DescribeDashboardSnapshotJobRequest.Builder> describeDashboardSnapshotJobRequest) throws AccessDeniedException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes an existing snapshot job.
Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see
JobStatus.
This is a convenience which creates an instance of the
DescribeDashboardSnapshotJobRequest.Builderavoiding the need to create one manually viaDescribeDashboardSnapshotJobRequest.builder()- Parameters:
describeDashboardSnapshotJobRequest- AConsumerthat will call methods onDescribeDashboardSnapshotJobRequest.Builderto create a request.- Returns:
- Result of the DescribeDashboardSnapshotJob operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDashboardSnapshotJobResult
default DescribeDashboardSnapshotJobResultResponse describeDashboardSnapshotJobResult(DescribeDashboardSnapshotJobResultRequest describeDashboardSnapshotJobResultRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, PreconditionNotMetException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the result of an existing snapshot job that has finished running.
A finished snapshot job will return a
COMPLETEDorFAILEDstatus when you poll the job with aDescribeDashboardSnapshotJobAPI call.If the job has not finished running, this operation returns a message that says
Dashboard Snapshot Job with id <SnapshotjobId> has not reached a terminal state..- Parameters:
describeDashboardSnapshotJobResultRequest-- Returns:
- Result of the DescribeDashboardSnapshotJobResult operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDashboardSnapshotJobResult
default DescribeDashboardSnapshotJobResultResponse describeDashboardSnapshotJobResult(Consumer<DescribeDashboardSnapshotJobResultRequest.Builder> describeDashboardSnapshotJobResultRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, PreconditionNotMetException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the result of an existing snapshot job that has finished running.
A finished snapshot job will return a
COMPLETEDorFAILEDstatus when you poll the job with aDescribeDashboardSnapshotJobAPI call.If the job has not finished running, this operation returns a message that says
Dashboard Snapshot Job with id <SnapshotjobId> has not reached a terminal state..
This is a convenience which creates an instance of the
DescribeDashboardSnapshotJobResultRequest.Builderavoiding the need to create one manually viaDescribeDashboardSnapshotJobResultRequest.builder()- Parameters:
describeDashboardSnapshotJobResultRequest- AConsumerthat will call methods onDescribeDashboardSnapshotJobResultRequest.Builderto create a request.- Returns:
- Result of the DescribeDashboardSnapshotJobResult operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDashboardsQAConfiguration
default DescribeDashboardsQaConfigurationResponse describeDashboardsQAConfiguration(DescribeDashboardsQaConfigurationRequest describeDashboardsQaConfigurationRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes an existing dashboard QA configuration.
- Parameters:
describeDashboardsQaConfigurationRequest-- Returns:
- Result of the DescribeDashboardsQAConfiguration operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDashboardsQAConfiguration
default DescribeDashboardsQaConfigurationResponse describeDashboardsQAConfiguration(Consumer<DescribeDashboardsQaConfigurationRequest.Builder> describeDashboardsQaConfigurationRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes an existing dashboard QA configuration.
This is a convenience which creates an instance of the
DescribeDashboardsQaConfigurationRequest.Builderavoiding the need to create one manually viaDescribeDashboardsQaConfigurationRequest.builder()- Parameters:
describeDashboardsQaConfigurationRequest- AConsumerthat will call methods onDescribeDashboardsQaConfigurationRequest.Builderto create a request.- Returns:
- Result of the DescribeDashboardsQAConfiguration operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDataSet
default DescribeDataSetResponse describeDataSet(DescribeDataSetRequest describeDataSetRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.
- Parameters:
describeDataSetRequest-- Returns:
- Result of the DescribeDataSet operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDataSet
default DescribeDataSetResponse describeDataSet(Consumer<DescribeDataSetRequest.Builder> describeDataSetRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.
This is a convenience which creates an instance of the
DescribeDataSetRequest.Builderavoiding the need to create one manually viaDescribeDataSetRequest.builder()- Parameters:
describeDataSetRequest- AConsumerthat will call methods onDescribeDataSetRequest.Builderto create a request.- Returns:
- Result of the DescribeDataSet operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDataSetPermissions
default DescribeDataSetPermissionsResponse describeDataSetPermissions(DescribeDataSetPermissionsRequest describeDataSetPermissionsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the permissions on a dataset.
The permissions resource is
arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.- Parameters:
describeDataSetPermissionsRequest-- Returns:
- Result of the DescribeDataSetPermissions operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDataSetPermissions
default DescribeDataSetPermissionsResponse describeDataSetPermissions(Consumer<DescribeDataSetPermissionsRequest.Builder> describeDataSetPermissionsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the permissions on a dataset.
The permissions resource is
arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
This is a convenience which creates an instance of the
DescribeDataSetPermissionsRequest.Builderavoiding the need to create one manually viaDescribeDataSetPermissionsRequest.builder()- Parameters:
describeDataSetPermissionsRequest- AConsumerthat will call methods onDescribeDataSetPermissionsRequest.Builderto create a request.- Returns:
- Result of the DescribeDataSetPermissions operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDataSetRefreshProperties
default DescribeDataSetRefreshPropertiesResponse describeDataSetRefreshProperties(DescribeDataSetRefreshPropertiesRequest describeDataSetRefreshPropertiesRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, PreconditionNotMetException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the refresh properties of a dataset.
- Parameters:
describeDataSetRefreshPropertiesRequest-- Returns:
- Result of the DescribeDataSetRefreshProperties operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDataSetRefreshProperties
default DescribeDataSetRefreshPropertiesResponse describeDataSetRefreshProperties(Consumer<DescribeDataSetRefreshPropertiesRequest.Builder> describeDataSetRefreshPropertiesRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, PreconditionNotMetException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the refresh properties of a dataset.
This is a convenience which creates an instance of the
DescribeDataSetRefreshPropertiesRequest.Builderavoiding the need to create one manually viaDescribeDataSetRefreshPropertiesRequest.builder()- Parameters:
describeDataSetRefreshPropertiesRequest- AConsumerthat will call methods onDescribeDataSetRefreshPropertiesRequest.Builderto create a request.- Returns:
- Result of the DescribeDataSetRefreshProperties operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDataSource
default DescribeDataSourceResponse describeDataSource(DescribeDataSourceRequest describeDataSourceRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a data source.
- Parameters:
describeDataSourceRequest-- Returns:
- Result of the DescribeDataSource operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDataSource
default DescribeDataSourceResponse describeDataSource(Consumer<DescribeDataSourceRequest.Builder> describeDataSourceRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a data source.
This is a convenience which creates an instance of the
DescribeDataSourceRequest.Builderavoiding the need to create one manually viaDescribeDataSourceRequest.builder()- Parameters:
describeDataSourceRequest- AConsumerthat will call methods onDescribeDataSourceRequest.Builderto create a request.- Returns:
- Result of the DescribeDataSource operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDataSourcePermissions
default DescribeDataSourcePermissionsResponse describeDataSourcePermissions(DescribeDataSourcePermissionsRequest describeDataSourcePermissionsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the resource permissions for a data source.
- Parameters:
describeDataSourcePermissionsRequest-- Returns:
- Result of the DescribeDataSourcePermissions operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDataSourcePermissions
default DescribeDataSourcePermissionsResponse describeDataSourcePermissions(Consumer<DescribeDataSourcePermissionsRequest.Builder> describeDataSourcePermissionsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the resource permissions for a data source.
This is a convenience which creates an instance of the
DescribeDataSourcePermissionsRequest.Builderavoiding the need to create one manually viaDescribeDataSourcePermissionsRequest.builder()- Parameters:
describeDataSourcePermissionsRequest- AConsumerthat will call methods onDescribeDataSourcePermissionsRequest.Builderto create a request.- Returns:
- Result of the DescribeDataSourcePermissions operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDefaultQBusinessApplication
default DescribeDefaultQBusinessApplicationResponse describeDefaultQBusinessApplication(DescribeDefaultQBusinessApplicationRequest describeDefaultQBusinessApplicationRequest) throws AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidParameterValueException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a Amazon Q Business application that is linked to an QuickSight account.
- Parameters:
describeDefaultQBusinessApplicationRequest-- Returns:
- Result of the DescribeDefaultQBusinessApplication operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.InvalidParameterValueException- One or more parameters has a value that isn't valid.InternalFailureException- An internal failure occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDefaultQBusinessApplication
default DescribeDefaultQBusinessApplicationResponse describeDefaultQBusinessApplication(Consumer<DescribeDefaultQBusinessApplicationRequest.Builder> describeDefaultQBusinessApplicationRequest) throws AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidParameterValueException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a Amazon Q Business application that is linked to an QuickSight account.
This is a convenience which creates an instance of the
DescribeDefaultQBusinessApplicationRequest.Builderavoiding the need to create one manually viaDescribeDefaultQBusinessApplicationRequest.builder()- Parameters:
describeDefaultQBusinessApplicationRequest- AConsumerthat will call methods onDescribeDefaultQBusinessApplicationRequest.Builderto create a request.- Returns:
- Result of the DescribeDefaultQBusinessApplication operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.InvalidParameterValueException- One or more parameters has a value that isn't valid.InternalFailureException- An internal failure occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeFolder
default DescribeFolderResponse describeFolder(DescribeFolderRequest describeFolderRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a folder.
- Parameters:
describeFolderRequest-- Returns:
- Result of the DescribeFolder operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeFolder
default DescribeFolderResponse describeFolder(Consumer<DescribeFolderRequest.Builder> describeFolderRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a folder.
This is a convenience which creates an instance of the
DescribeFolderRequest.Builderavoiding the need to create one manually viaDescribeFolderRequest.builder()- Parameters:
describeFolderRequest- AConsumerthat will call methods onDescribeFolderRequest.Builderto create a request.- Returns:
- Result of the DescribeFolder operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeFolderPermissions
default DescribeFolderPermissionsResponse describeFolderPermissions(DescribeFolderPermissionsRequest describeFolderPermissionsRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes permissions for a folder.
- Parameters:
describeFolderPermissionsRequest-- Returns:
- Result of the DescribeFolderPermissions operation returned by the service.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeFolderPermissions
default DescribeFolderPermissionsResponse describeFolderPermissions(Consumer<DescribeFolderPermissionsRequest.Builder> describeFolderPermissionsRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes permissions for a folder.
This is a convenience which creates an instance of the
DescribeFolderPermissionsRequest.Builderavoiding the need to create one manually viaDescribeFolderPermissionsRequest.builder()- Parameters:
describeFolderPermissionsRequest- AConsumerthat will call methods onDescribeFolderPermissionsRequest.Builderto create a request.- Returns:
- Result of the DescribeFolderPermissions operation returned by the service.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeFolderPermissionsPaginator
default DescribeFolderPermissionsIterable describeFolderPermissionsPaginator(DescribeFolderPermissionsRequest describeFolderPermissionsRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
describeFolderPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.DescribeFolderPermissionsIterable responses = client.describeFolderPermissionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.DescribeFolderPermissionsIterable responses = client .describeFolderPermissionsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.DescribeFolderPermissionsIterable responses = client.describeFolderPermissionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFolderPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsRequest)operation.- Parameters:
describeFolderPermissionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeFolderPermissionsPaginator
default DescribeFolderPermissionsIterable describeFolderPermissionsPaginator(Consumer<DescribeFolderPermissionsRequest.Builder> describeFolderPermissionsRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
describeFolderPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.DescribeFolderPermissionsIterable responses = client.describeFolderPermissionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.DescribeFolderPermissionsIterable responses = client .describeFolderPermissionsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.DescribeFolderPermissionsIterable responses = client.describeFolderPermissionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFolderPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderPermissionsRequest)operation.
This is a convenience which creates an instance of the
DescribeFolderPermissionsRequest.Builderavoiding the need to create one manually viaDescribeFolderPermissionsRequest.builder()- Parameters:
describeFolderPermissionsRequest- AConsumerthat will call methods onDescribeFolderPermissionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeFolderResolvedPermissions
default DescribeFolderResolvedPermissionsResponse describeFolderResolvedPermissions(DescribeFolderResolvedPermissionsRequest describeFolderResolvedPermissionsRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
- Parameters:
describeFolderResolvedPermissionsRequest-- Returns:
- Result of the DescribeFolderResolvedPermissions operation returned by the service.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeFolderResolvedPermissions
default DescribeFolderResolvedPermissionsResponse describeFolderResolvedPermissions(Consumer<DescribeFolderResolvedPermissionsRequest.Builder> describeFolderResolvedPermissionsRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
This is a convenience which creates an instance of the
DescribeFolderResolvedPermissionsRequest.Builderavoiding the need to create one manually viaDescribeFolderResolvedPermissionsRequest.builder()- Parameters:
describeFolderResolvedPermissionsRequest- AConsumerthat will call methods onDescribeFolderResolvedPermissionsRequest.Builderto create a request.- Returns:
- Result of the DescribeFolderResolvedPermissions operation returned by the service.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeFolderResolvedPermissionsPaginator
default DescribeFolderResolvedPermissionsIterable describeFolderResolvedPermissionsPaginator(DescribeFolderResolvedPermissionsRequest describeFolderResolvedPermissionsRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
describeFolderResolvedPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.DescribeFolderResolvedPermissionsIterable responses = client.describeFolderResolvedPermissionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.DescribeFolderResolvedPermissionsIterable responses = client .describeFolderResolvedPermissionsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.DescribeFolderResolvedPermissionsIterable responses = client.describeFolderResolvedPermissionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFolderResolvedPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsRequest)operation.- Parameters:
describeFolderResolvedPermissionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeFolderResolvedPermissionsPaginator
default DescribeFolderResolvedPermissionsIterable describeFolderResolvedPermissionsPaginator(Consumer<DescribeFolderResolvedPermissionsRequest.Builder> describeFolderResolvedPermissionsRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
describeFolderResolvedPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.DescribeFolderResolvedPermissionsIterable responses = client.describeFolderResolvedPermissionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.DescribeFolderResolvedPermissionsIterable responses = client .describeFolderResolvedPermissionsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.DescribeFolderResolvedPermissionsIterable responses = client.describeFolderResolvedPermissionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFolderResolvedPermissions(software.amazon.awssdk.services.quicksight.model.DescribeFolderResolvedPermissionsRequest)operation.
This is a convenience which creates an instance of the
DescribeFolderResolvedPermissionsRequest.Builderavoiding the need to create one manually viaDescribeFolderResolvedPermissionsRequest.builder()- Parameters:
describeFolderResolvedPermissionsRequest- AConsumerthat will call methods onDescribeFolderResolvedPermissionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeGroup
default DescribeGroupResponse describeGroup(DescribeGroupRequest describeGroupRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
- Parameters:
describeGroupRequest-- Returns:
- Result of the DescribeGroup operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeGroup
default DescribeGroupResponse describeGroup(Consumer<DescribeGroupRequest.Builder> describeGroupRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
This is a convenience which creates an instance of the
DescribeGroupRequest.Builderavoiding the need to create one manually viaDescribeGroupRequest.builder()- Parameters:
describeGroupRequest- AConsumerthat will call methods onDescribeGroupRequest.Builderto create a request.- Returns:
- Result of the DescribeGroup operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeGroupMembership
default DescribeGroupMembershipResponse describeGroupMembership(DescribeGroupMembershipRequest describeGroupMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Use the
DescribeGroupMembershipoperation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associatedGroupMemberobject is returned.- Parameters:
describeGroupMembershipRequest-- Returns:
- Result of the DescribeGroupMembership operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeGroupMembership
default DescribeGroupMembershipResponse describeGroupMembership(Consumer<DescribeGroupMembershipRequest.Builder> describeGroupMembershipRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Use the
DescribeGroupMembershipoperation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associatedGroupMemberobject is returned.
This is a convenience which creates an instance of the
DescribeGroupMembershipRequest.Builderavoiding the need to create one manually viaDescribeGroupMembershipRequest.builder()- Parameters:
describeGroupMembershipRequest- AConsumerthat will call methods onDescribeGroupMembershipRequest.Builderto create a request.- Returns:
- Result of the DescribeGroupMembership operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeIAMPolicyAssignment
default DescribeIamPolicyAssignmentResponse describeIAMPolicyAssignment(DescribeIamPolicyAssignmentRequest describeIamPolicyAssignmentRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes an existing IAM policy assignment, as specified by the assignment name.
- Parameters:
describeIamPolicyAssignmentRequest-- Returns:
- Result of the DescribeIAMPolicyAssignment operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeIAMPolicyAssignment
default DescribeIamPolicyAssignmentResponse describeIAMPolicyAssignment(Consumer<DescribeIamPolicyAssignmentRequest.Builder> describeIamPolicyAssignmentRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes an existing IAM policy assignment, as specified by the assignment name.
This is a convenience which creates an instance of the
DescribeIamPolicyAssignmentRequest.Builderavoiding the need to create one manually viaDescribeIamPolicyAssignmentRequest.builder()- Parameters:
describeIamPolicyAssignmentRequest- AConsumerthat will call methods onDescribeIamPolicyAssignmentRequest.Builderto create a request.- Returns:
- Result of the DescribeIAMPolicyAssignment operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeIngestion
default DescribeIngestionResponse describeIngestion(DescribeIngestionRequest describeIngestionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ResourceExistsException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a SPICE ingestion.
- Parameters:
describeIngestionRequest-- Returns:
- Result of the DescribeIngestion operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeIngestion
default DescribeIngestionResponse describeIngestion(Consumer<DescribeIngestionRequest.Builder> describeIngestionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ResourceExistsException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a SPICE ingestion.
This is a convenience which creates an instance of the
DescribeIngestionRequest.Builderavoiding the need to create one manually viaDescribeIngestionRequest.builder()- Parameters:
describeIngestionRequest- AConsumerthat will call methods onDescribeIngestionRequest.Builderto create a request.- Returns:
- Result of the DescribeIngestion operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeIpRestriction
default DescribeIpRestrictionResponse describeIpRestriction(DescribeIpRestrictionRequest describeIpRestrictionRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides a summary and status of IP rules.
- Parameters:
describeIpRestrictionRequest-- Returns:
- Result of the DescribeIpRestriction operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeIpRestriction
default DescribeIpRestrictionResponse describeIpRestriction(Consumer<DescribeIpRestrictionRequest.Builder> describeIpRestrictionRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides a summary and status of IP rules.
This is a convenience which creates an instance of the
DescribeIpRestrictionRequest.Builderavoiding the need to create one manually viaDescribeIpRestrictionRequest.builder()- Parameters:
describeIpRestrictionRequest- AConsumerthat will call methods onDescribeIpRestrictionRequest.Builderto create a request.- Returns:
- Result of the DescribeIpRestriction operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeKeyRegistration
default DescribeKeyRegistrationResponse describeKeyRegistration(DescribeKeyRegistrationRequest describeKeyRegistrationRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes all customer managed key registrations in a QuickSight account.
- Parameters:
describeKeyRegistrationRequest-- Returns:
- Result of the DescribeKeyRegistration operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeKeyRegistration
default DescribeKeyRegistrationResponse describeKeyRegistration(Consumer<DescribeKeyRegistrationRequest.Builder> describeKeyRegistrationRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes all customer managed key registrations in a QuickSight account.
This is a convenience which creates an instance of the
DescribeKeyRegistrationRequest.Builderavoiding the need to create one manually viaDescribeKeyRegistrationRequest.builder()- Parameters:
describeKeyRegistrationRequest- AConsumerthat will call methods onDescribeKeyRegistrationRequest.Builderto create a request.- Returns:
- Result of the DescribeKeyRegistration operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeNamespace
default DescribeNamespaceResponse describeNamespace(DescribeNamespaceRequest describeNamespaceRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Describes the current namespace.
- Parameters:
describeNamespaceRequest-- Returns:
- Result of the DescribeNamespace operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeNamespace
default DescribeNamespaceResponse describeNamespace(Consumer<DescribeNamespaceRequest.Builder> describeNamespaceRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Describes the current namespace.
This is a convenience which creates an instance of the
DescribeNamespaceRequest.Builderavoiding the need to create one manually viaDescribeNamespaceRequest.builder()- Parameters:
describeNamespaceRequest- AConsumerthat will call methods onDescribeNamespaceRequest.Builderto create a request.- Returns:
- Result of the DescribeNamespace operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeQPersonalizationConfiguration
default DescribeQPersonalizationConfigurationResponse describeQPersonalizationConfiguration(DescribeQPersonalizationConfigurationRequest describeQPersonalizationConfigurationRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a personalization configuration.
- Parameters:
describeQPersonalizationConfigurationRequest-- Returns:
- Result of the DescribeQPersonalizationConfiguration operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeQPersonalizationConfiguration
default DescribeQPersonalizationConfigurationResponse describeQPersonalizationConfiguration(Consumer<DescribeQPersonalizationConfigurationRequest.Builder> describeQPersonalizationConfigurationRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a personalization configuration.
This is a convenience which creates an instance of the
DescribeQPersonalizationConfigurationRequest.Builderavoiding the need to create one manually viaDescribeQPersonalizationConfigurationRequest.builder()- Parameters:
describeQPersonalizationConfigurationRequest- AConsumerthat will call methods onDescribeQPersonalizationConfigurationRequest.Builderto create a request.- Returns:
- Result of the DescribeQPersonalizationConfiguration operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeQuickSightQSearchConfiguration
default DescribeQuickSightQSearchConfigurationResponse describeQuickSightQSearchConfiguration(DescribeQuickSightQSearchConfigurationRequest describeQuickSightQSearchConfigurationRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the state of a QuickSight Q Search configuration.
- Parameters:
describeQuickSightQSearchConfigurationRequest-- Returns:
- Result of the DescribeQuickSightQSearchConfiguration operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeQuickSightQSearchConfiguration
default DescribeQuickSightQSearchConfigurationResponse describeQuickSightQSearchConfiguration(Consumer<DescribeQuickSightQSearchConfigurationRequest.Builder> describeQuickSightQSearchConfigurationRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the state of a QuickSight Q Search configuration.
This is a convenience which creates an instance of the
DescribeQuickSightQSearchConfigurationRequest.Builderavoiding the need to create one manually viaDescribeQuickSightQSearchConfigurationRequest.builder()- Parameters:
describeQuickSightQSearchConfigurationRequest- AConsumerthat will call methods onDescribeQuickSightQSearchConfigurationRequest.Builderto create a request.- Returns:
- Result of the DescribeQuickSightQSearchConfiguration operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeRefreshSchedule
default DescribeRefreshScheduleResponse describeRefreshSchedule(DescribeRefreshScheduleRequest describeRefreshScheduleRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides a summary of a refresh schedule.
- Parameters:
describeRefreshScheduleRequest-- Returns:
- Result of the DescribeRefreshSchedule operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeRefreshSchedule
default DescribeRefreshScheduleResponse describeRefreshSchedule(Consumer<DescribeRefreshScheduleRequest.Builder> describeRefreshScheduleRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides a summary of a refresh schedule.
This is a convenience which creates an instance of the
DescribeRefreshScheduleRequest.Builderavoiding the need to create one manually viaDescribeRefreshScheduleRequest.builder()- Parameters:
describeRefreshScheduleRequest- AConsumerthat will call methods onDescribeRefreshScheduleRequest.Builderto create a request.- Returns:
- Result of the DescribeRefreshSchedule operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeRoleCustomPermission
default DescribeRoleCustomPermissionResponse describeRoleCustomPermission(DescribeRoleCustomPermissionRequest describeRoleCustomPermissionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Describes all custom permissions that are mapped to a role.
- Parameters:
describeRoleCustomPermissionRequest-- Returns:
- Result of the DescribeRoleCustomPermission operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeRoleCustomPermission
default DescribeRoleCustomPermissionResponse describeRoleCustomPermission(Consumer<DescribeRoleCustomPermissionRequest.Builder> describeRoleCustomPermissionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Describes all custom permissions that are mapped to a role.
This is a convenience which creates an instance of the
DescribeRoleCustomPermissionRequest.Builderavoiding the need to create one manually viaDescribeRoleCustomPermissionRequest.builder()- Parameters:
describeRoleCustomPermissionRequest- AConsumerthat will call methods onDescribeRoleCustomPermissionRequest.Builderto create a request.- Returns:
- Result of the DescribeRoleCustomPermission operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTemplate
default DescribeTemplateResponse describeTemplate(DescribeTemplateRequest describeTemplateRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a template's metadata.
- Parameters:
describeTemplateRequest-- Returns:
- Result of the DescribeTemplate operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTemplate
default DescribeTemplateResponse describeTemplate(Consumer<DescribeTemplateRequest.Builder> describeTemplateRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a template's metadata.
This is a convenience which creates an instance of the
DescribeTemplateRequest.Builderavoiding the need to create one manually viaDescribeTemplateRequest.builder()- Parameters:
describeTemplateRequest- AConsumerthat will call methods onDescribeTemplateRequest.Builderto create a request.- Returns:
- Result of the DescribeTemplate operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTemplateAlias
default DescribeTemplateAliasResponse describeTemplateAlias(DescribeTemplateAliasRequest describeTemplateAliasRequest) throws ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the template alias for a template.
- Parameters:
describeTemplateAliasRequest-- Returns:
- Result of the DescribeTemplateAlias operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTemplateAlias
default DescribeTemplateAliasResponse describeTemplateAlias(Consumer<DescribeTemplateAliasRequest.Builder> describeTemplateAliasRequest) throws ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the template alias for a template.
This is a convenience which creates an instance of the
DescribeTemplateAliasRequest.Builderavoiding the need to create one manually viaDescribeTemplateAliasRequest.builder()- Parameters:
describeTemplateAliasRequest- AConsumerthat will call methods onDescribeTemplateAliasRequest.Builderto create a request.- Returns:
- Result of the DescribeTemplateAlias operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTemplateDefinition
default DescribeTemplateDefinitionResponse describeTemplateDefinition(DescribeTemplateDefinitionRequest describeTemplateDefinitionRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides a detailed description of the definition of a template.
If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the
DescribeTemplateinstead.- Parameters:
describeTemplateDefinitionRequest-- Returns:
- Result of the DescribeTemplateDefinition operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTemplateDefinition
default DescribeTemplateDefinitionResponse describeTemplateDefinition(Consumer<DescribeTemplateDefinitionRequest.Builder> describeTemplateDefinitionRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Provides a detailed description of the definition of a template.
If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the
DescribeTemplateinstead.
This is a convenience which creates an instance of the
DescribeTemplateDefinitionRequest.Builderavoiding the need to create one manually viaDescribeTemplateDefinitionRequest.builder()- Parameters:
describeTemplateDefinitionRequest- AConsumerthat will call methods onDescribeTemplateDefinitionRequest.Builderto create a request.- Returns:
- Result of the DescribeTemplateDefinition operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTemplatePermissions
default DescribeTemplatePermissionsResponse describeTemplatePermissions(DescribeTemplatePermissionsRequest describeTemplatePermissionsRequest) throws ThrottlingException, InvalidParameterValueException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes read and write permissions on a template.
- Parameters:
describeTemplatePermissionsRequest-- Returns:
- Result of the DescribeTemplatePermissions operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTemplatePermissions
default DescribeTemplatePermissionsResponse describeTemplatePermissions(Consumer<DescribeTemplatePermissionsRequest.Builder> describeTemplatePermissionsRequest) throws ThrottlingException, InvalidParameterValueException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes read and write permissions on a template.
This is a convenience which creates an instance of the
DescribeTemplatePermissionsRequest.Builderavoiding the need to create one manually viaDescribeTemplatePermissionsRequest.builder()- Parameters:
describeTemplatePermissionsRequest- AConsumerthat will call methods onDescribeTemplatePermissionsRequest.Builderto create a request.- Returns:
- Result of the DescribeTemplatePermissions operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTheme
default DescribeThemeResponse describeTheme(DescribeThemeRequest describeThemeRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a theme.
- Parameters:
describeThemeRequest-- Returns:
- Result of the DescribeTheme operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTheme
default DescribeThemeResponse describeTheme(Consumer<DescribeThemeRequest.Builder> describeThemeRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a theme.
This is a convenience which creates an instance of the
DescribeThemeRequest.Builderavoiding the need to create one manually viaDescribeThemeRequest.builder()- Parameters:
describeThemeRequest- AConsumerthat will call methods onDescribeThemeRequest.Builderto create a request.- Returns:
- Result of the DescribeTheme operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeThemeAlias
default DescribeThemeAliasResponse describeThemeAlias(DescribeThemeAliasRequest describeThemeAliasRequest) throws ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the alias for a theme.
- Parameters:
describeThemeAliasRequest-- Returns:
- Result of the DescribeThemeAlias operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeThemeAlias
default DescribeThemeAliasResponse describeThemeAlias(Consumer<DescribeThemeAliasRequest.Builder> describeThemeAliasRequest) throws ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the alias for a theme.
This is a convenience which creates an instance of the
DescribeThemeAliasRequest.Builderavoiding the need to create one manually viaDescribeThemeAliasRequest.builder()- Parameters:
describeThemeAliasRequest- AConsumerthat will call methods onDescribeThemeAliasRequest.Builderto create a request.- Returns:
- Result of the DescribeThemeAlias operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeThemePermissions
default DescribeThemePermissionsResponse describeThemePermissions(DescribeThemePermissionsRequest describeThemePermissionsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the read and write permissions for a theme.
- Parameters:
describeThemePermissionsRequest-- Returns:
- Result of the DescribeThemePermissions operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeThemePermissions
default DescribeThemePermissionsResponse describeThemePermissions(Consumer<DescribeThemePermissionsRequest.Builder> describeThemePermissionsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the read and write permissions for a theme.
This is a convenience which creates an instance of the
DescribeThemePermissionsRequest.Builderavoiding the need to create one manually viaDescribeThemePermissionsRequest.builder()- Parameters:
describeThemePermissionsRequest- AConsumerthat will call methods onDescribeThemePermissionsRequest.Builderto create a request.- Returns:
- Result of the DescribeThemePermissions operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTopic
default DescribeTopicResponse describeTopic(DescribeTopicRequest describeTopicRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a topic.
- Parameters:
describeTopicRequest-- Returns:
- Result of the DescribeTopic operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTopic
default DescribeTopicResponse describeTopic(Consumer<DescribeTopicRequest.Builder> describeTopicRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a topic.
This is a convenience which creates an instance of the
DescribeTopicRequest.Builderavoiding the need to create one manually viaDescribeTopicRequest.builder()- Parameters:
describeTopicRequest- AConsumerthat will call methods onDescribeTopicRequest.Builderto create a request.- Returns:
- Result of the DescribeTopic operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTopicPermissions
default DescribeTopicPermissionsResponse describeTopicPermissions(DescribeTopicPermissionsRequest describeTopicPermissionsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the permissions of a topic.
- Parameters:
describeTopicPermissionsRequest-- Returns:
- Result of the DescribeTopicPermissions operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTopicPermissions
default DescribeTopicPermissionsResponse describeTopicPermissions(Consumer<DescribeTopicPermissionsRequest.Builder> describeTopicPermissionsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the permissions of a topic.
This is a convenience which creates an instance of the
DescribeTopicPermissionsRequest.Builderavoiding the need to create one manually viaDescribeTopicPermissionsRequest.builder()- Parameters:
describeTopicPermissionsRequest- AConsumerthat will call methods onDescribeTopicPermissionsRequest.Builderto create a request.- Returns:
- Result of the DescribeTopicPermissions operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTopicRefresh
default DescribeTopicRefreshResponse describeTopicRefresh(DescribeTopicRefreshRequest describeTopicRefreshRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the status of a topic refresh.
- Parameters:
describeTopicRefreshRequest-- Returns:
- Result of the DescribeTopicRefresh operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTopicRefresh
default DescribeTopicRefreshResponse describeTopicRefresh(Consumer<DescribeTopicRefreshRequest.Builder> describeTopicRefreshRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes the status of a topic refresh.
This is a convenience which creates an instance of the
DescribeTopicRefreshRequest.Builderavoiding the need to create one manually viaDescribeTopicRefreshRequest.builder()- Parameters:
describeTopicRefreshRequest- AConsumerthat will call methods onDescribeTopicRefreshRequest.Builderto create a request.- Returns:
- Result of the DescribeTopicRefresh operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTopicRefreshSchedule
default DescribeTopicRefreshScheduleResponse describeTopicRefreshSchedule(DescribeTopicRefreshScheduleRequest describeTopicRefreshScheduleRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceNotFoundException, ResourceExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a topic refresh schedule.
- Parameters:
describeTopicRefreshScheduleRequest-- Returns:
- Result of the DescribeTopicRefreshSchedule operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeTopicRefreshSchedule
default DescribeTopicRefreshScheduleResponse describeTopicRefreshSchedule(Consumer<DescribeTopicRefreshScheduleRequest.Builder> describeTopicRefreshScheduleRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceNotFoundException, ResourceExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Deletes a topic refresh schedule.
This is a convenience which creates an instance of the
DescribeTopicRefreshScheduleRequest.Builderavoiding the need to create one manually viaDescribeTopicRefreshScheduleRequest.builder()- Parameters:
describeTopicRefreshScheduleRequest- AConsumerthat will call methods onDescribeTopicRefreshScheduleRequest.Builderto create a request.- Returns:
- Result of the DescribeTopicRefreshSchedule operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUser
default DescribeUserResponse describeUser(DescribeUserRequest describeUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Returns information about a user, given the user name.
- Parameters:
describeUserRequest-- Returns:
- Result of the DescribeUser operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeUser
default DescribeUserResponse describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Returns information about a user, given the user name.
This is a convenience which creates an instance of the
DescribeUserRequest.Builderavoiding the need to create one manually viaDescribeUserRequest.builder()- Parameters:
describeUserRequest- AConsumerthat will call methods onDescribeUserRequest.Builderto create a request.- Returns:
- Result of the DescribeUser operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeVPCConnection
default DescribeVpcConnectionResponse describeVPCConnection(DescribeVpcConnectionRequest describeVpcConnectionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a VPC connection.
- Parameters:
describeVpcConnectionRequest-- Returns:
- Result of the DescribeVPCConnection operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeVPCConnection
default DescribeVpcConnectionResponse describeVPCConnection(Consumer<DescribeVpcConnectionRequest.Builder> describeVpcConnectionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Describes a VPC connection.
This is a convenience which creates an instance of the
DescribeVpcConnectionRequest.Builderavoiding the need to create one manually viaDescribeVpcConnectionRequest.builder()- Parameters:
describeVpcConnectionRequest- AConsumerthat will call methods onDescribeVpcConnectionRequest.Builderto create a request.- Returns:
- Result of the DescribeVPCConnection operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
generateEmbedUrlForAnonymousUser
default GenerateEmbedUrlForAnonymousUserResponse generateEmbedUrlForAnonymousUser(GenerateEmbedUrlForAnonymousUserRequest generateEmbedUrlForAnonymousUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, SessionLifetimeInMinutesInvalidException, UnsupportedUserEditionException, UnsupportedPricingPlanException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.
The following rules apply to the generated URL:
-
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
-
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutesparameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours. -
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
- Parameters:
generateEmbedUrlForAnonymousUserRequest-- Returns:
- Result of the GenerateEmbedUrlForAnonymousUser operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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 QuickSight. You can do this on the Manage QuickSight page.After capacity pricing is added, you can use the
GetDashboardEmbedUrlAPI operation with the--identity-type ANONYMOUSoption.InternalFailureException- An internal failure occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
generateEmbedUrlForAnonymousUser
default GenerateEmbedUrlForAnonymousUserResponse generateEmbedUrlForAnonymousUser(Consumer<GenerateEmbedUrlForAnonymousUserRequest.Builder> generateEmbedUrlForAnonymousUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, SessionLifetimeInMinutesInvalidException, UnsupportedUserEditionException, UnsupportedPricingPlanException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.
The following rules apply to the generated URL:
-
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
-
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutesparameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours. -
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
This is a convenience which creates an instance of the
GenerateEmbedUrlForAnonymousUserRequest.Builderavoiding the need to create one manually viaGenerateEmbedUrlForAnonymousUserRequest.builder()- Parameters:
generateEmbedUrlForAnonymousUserRequest- AConsumerthat will call methods onGenerateEmbedUrlForAnonymousUserRequest.Builderto create a request.- Returns:
- Result of the GenerateEmbedUrlForAnonymousUser operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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 QuickSight. You can do this on the Manage QuickSight page.After capacity pricing is added, you can use the
GetDashboardEmbedUrlAPI operation with the--identity-type ANONYMOUSoption.InternalFailureException- An internal failure occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
generateEmbedUrlForRegisteredUser
default GenerateEmbedUrlForRegisteredUserResponse generateEmbedUrlForRegisteredUser(GenerateEmbedUrlForRegisteredUserRequest generateEmbedUrlForRegisteredUserRequest) throws AccessDeniedException, InvalidParameterValueException, QuickSightUserNotFoundException, ResourceNotFoundException, SessionLifetimeInMinutesInvalidException, ThrottlingException, UnsupportedUserEditionException, UnsupportedPricingPlanException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.
The following rules apply to the generated URL:
-
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
-
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutesparameter.The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.
-
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
- Parameters:
generateEmbedUrlForRegisteredUserRequest-- Returns:
- Result of the GenerateEmbedUrlForRegisteredUser operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 asDeleteUser,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 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 QuickSight. You can do this on the Manage QuickSight page.After capacity pricing is added, you can use the
GetDashboardEmbedUrlAPI operation with the--identity-type ANONYMOUSoption.InternalFailureException- An internal failure occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
generateEmbedUrlForRegisteredUser
default GenerateEmbedUrlForRegisteredUserResponse generateEmbedUrlForRegisteredUser(Consumer<GenerateEmbedUrlForRegisteredUserRequest.Builder> generateEmbedUrlForRegisteredUserRequest) throws AccessDeniedException, InvalidParameterValueException, QuickSightUserNotFoundException, ResourceNotFoundException, SessionLifetimeInMinutesInvalidException, ThrottlingException, UnsupportedUserEditionException, UnsupportedPricingPlanException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.
The following rules apply to the generated URL:
-
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
-
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutesparameter.The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.
-
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
This is a convenience which creates an instance of the
GenerateEmbedUrlForRegisteredUserRequest.Builderavoiding the need to create one manually viaGenerateEmbedUrlForRegisteredUserRequest.builder()- Parameters:
generateEmbedUrlForRegisteredUserRequest- AConsumerthat will call methods onGenerateEmbedUrlForRegisteredUserRequest.Builderto create a request.- Returns:
- Result of the GenerateEmbedUrlForRegisteredUser operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 asDeleteUser,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 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 QuickSight. You can do this on the Manage QuickSight page.After capacity pricing is added, you can use the
GetDashboardEmbedUrlAPI operation with the--identity-type ANONYMOUSoption.InternalFailureException- An internal failure occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
generateEmbedUrlForRegisteredUserWithIdentity
default GenerateEmbedUrlForRegisteredUserWithIdentityResponse generateEmbedUrlForRegisteredUserWithIdentity(GenerateEmbedUrlForRegisteredUserWithIdentityRequest generateEmbedUrlForRegisteredUserWithIdentityRequest) throws AccessDeniedException, InvalidParameterValueException, QuickSightUserNotFoundException, ResourceNotFoundException, SessionLifetimeInMinutesInvalidException, ThrottlingException, UnsupportedUserEditionException, UnsupportedPricingPlanException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Generates an embed URL that you can use to embed an QuickSight experience in your website. This action can be used for any type of user that is registered in an QuickSight account that uses IAM Identity Center for authentication. This API requires identity-enhanced IAM Role sessions for the authenticated user that the API call is being made for.
This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for QuickSight with the scope value set to
quicksight:read. Before you use this action, make sure that you have configured the relevant QuickSight resource and permissions.- Parameters:
generateEmbedUrlForRegisteredUserWithIdentityRequest-- Returns:
- Result of the GenerateEmbedUrlForRegisteredUserWithIdentity operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 asDeleteUser,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 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 QuickSight. You can do this on the Manage QuickSight page.After capacity pricing is added, you can use the
GetDashboardEmbedUrlAPI operation with the--identity-type ANONYMOUSoption.InternalFailureException- An internal failure occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
generateEmbedUrlForRegisteredUserWithIdentity
default GenerateEmbedUrlForRegisteredUserWithIdentityResponse generateEmbedUrlForRegisteredUserWithIdentity(Consumer<GenerateEmbedUrlForRegisteredUserWithIdentityRequest.Builder> generateEmbedUrlForRegisteredUserWithIdentityRequest) throws AccessDeniedException, InvalidParameterValueException, QuickSightUserNotFoundException, ResourceNotFoundException, SessionLifetimeInMinutesInvalidException, ThrottlingException, UnsupportedUserEditionException, UnsupportedPricingPlanException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Generates an embed URL that you can use to embed an QuickSight experience in your website. This action can be used for any type of user that is registered in an QuickSight account that uses IAM Identity Center for authentication. This API requires identity-enhanced IAM Role sessions for the authenticated user that the API call is being made for.
This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for QuickSight with the scope value set to
quicksight:read. Before you use this action, make sure that you have configured the relevant QuickSight resource and permissions.
This is a convenience which creates an instance of the
GenerateEmbedUrlForRegisteredUserWithIdentityRequest.Builderavoiding the need to create one manually viaGenerateEmbedUrlForRegisteredUserWithIdentityRequest.builder()- Parameters:
generateEmbedUrlForRegisteredUserWithIdentityRequest- AConsumerthat will call methods onGenerateEmbedUrlForRegisteredUserWithIdentityRequest.Builderto create a request.- Returns:
- Result of the GenerateEmbedUrlForRegisteredUserWithIdentity operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 asDeleteUser,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 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 QuickSight. You can do this on the Manage QuickSight page.After capacity pricing is added, you can use the
GetDashboardEmbedUrlAPI operation with the--identity-type ANONYMOUSoption.InternalFailureException- An internal failure occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getDashboardEmbedUrl
default GetDashboardEmbedUrlResponse getDashboardEmbedUrl(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, DomainNotWhitelistedException, QuickSightUserNotFoundException, IdentityTypeNotSupportedException, SessionLifetimeInMinutesInvalidException, UnsupportedUserEditionException, UnsupportedPricingPlanException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Generates a temporary session URL and authorization code(bearer token) that you can use to embed an 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
GetDashboardEmbedURLonly from the server, not from the user's browser. The following rules apply to the generated URL:-
They must be used together.
-
They can be used one time only.
-
They are valid for 5 minutes after you run this command.
-
You are charged only when the URL is used or there is interaction with QuickSight.
-
The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional
SessionLifetimeInMinutesparameter to customize session duration.
For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
- Parameters:
getDashboardEmbedUrlRequest-- Returns:
- Result of the GetDashboardEmbedUrl operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 asDeleteUser,DescribeUser, and so on.IdentityTypeNotSupportedException- The identity type specified isn't supported. Supported identity types includeIAMandQUICKSIGHT.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 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 QuickSight. You can do this on the Manage QuickSight page.After capacity pricing is added, you can use the
GetDashboardEmbedUrlAPI operation with the--identity-type ANONYMOUSoption.InternalFailureException- An internal failure occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
getDashboardEmbedUrl
default GetDashboardEmbedUrlResponse getDashboardEmbedUrl(Consumer<GetDashboardEmbedUrlRequest.Builder> getDashboardEmbedUrlRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, DomainNotWhitelistedException, QuickSightUserNotFoundException, IdentityTypeNotSupportedException, SessionLifetimeInMinutesInvalidException, UnsupportedUserEditionException, UnsupportedPricingPlanException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Generates a temporary session URL and authorization code(bearer token) that you can use to embed an 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
GetDashboardEmbedURLonly from the server, not from the user's browser. The following rules apply to the generated URL:-
They must be used together.
-
They can be used one time only.
-
They are valid for 5 minutes after you run this command.
-
You are charged only when the URL is used or there is interaction with QuickSight.
-
The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional
SessionLifetimeInMinutesparameter to customize session duration.
For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
This is a convenience which creates an instance of the
GetDashboardEmbedUrlRequest.Builderavoiding the need to create one manually viaGetDashboardEmbedUrlRequest.builder()- Parameters:
getDashboardEmbedUrlRequest- AConsumerthat will call methods onGetDashboardEmbedUrlRequest.Builderto create a request.- Returns:
- Result of the GetDashboardEmbedUrl operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 asDeleteUser,DescribeUser, and so on.IdentityTypeNotSupportedException- The identity type specified isn't supported. Supported identity types includeIAMandQUICKSIGHT.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 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 QuickSight. You can do this on the Manage QuickSight page.After capacity pricing is added, you can use the
GetDashboardEmbedUrlAPI operation with the--identity-type ANONYMOUSoption.InternalFailureException- An internal failure occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
getSessionEmbedUrl
default GetSessionEmbedUrlResponse getSessionEmbedUrl(GetSessionEmbedUrlRequest getSessionEmbedUrlRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, QuickSightUserNotFoundException, SessionLifetimeInMinutesInvalidException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Generates a session URL and authorization code that you can use to embed the Amazon QuickSight console in your web server code. Use
GetSessionEmbedUrlwhere you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded 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 theUpdateUserAPI operation. UseRegisterUserAPI operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:- Parameters:
getSessionEmbedUrlRequest-- Returns:
- Result of the GetSessionEmbedUrl operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 asDeleteUser,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 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.AwsServiceException- See Also:
- AWS API Documentation
-
getSessionEmbedUrl
default GetSessionEmbedUrlResponse getSessionEmbedUrl(Consumer<GetSessionEmbedUrlRequest.Builder> getSessionEmbedUrlRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, QuickSightUserNotFoundException, SessionLifetimeInMinutesInvalidException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Generates a session URL and authorization code that you can use to embed the Amazon QuickSight console in your web server code. Use
GetSessionEmbedUrlwhere you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded 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 theUpdateUserAPI operation. UseRegisterUserAPI operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:
This is a convenience which creates an instance of the
GetSessionEmbedUrlRequest.Builderavoiding the need to create one manually viaGetSessionEmbedUrlRequest.builder()- Parameters:
getSessionEmbedUrlRequest- AConsumerthat will call methods onGetSessionEmbedUrlRequest.Builderto create a request.- Returns:
- Result of the GetSessionEmbedUrl operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 asDeleteUser,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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listAnalyses
default ListAnalysesResponse listAnalyses(ListAnalysesRequest listAnalysesRequest) throws ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
- Parameters:
listAnalysesRequest-- Returns:
- Result of the ListAnalyses operation returned by the service.
- Throws:
ThrottlingException- Access is throttled.InvalidNextTokenException- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listAnalyses
default ListAnalysesResponse listAnalyses(Consumer<ListAnalysesRequest.Builder> listAnalysesRequest) throws ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
This is a convenience which creates an instance of the
ListAnalysesRequest.Builderavoiding the need to create one manually viaListAnalysesRequest.builder()- Parameters:
listAnalysesRequest- AConsumerthat will call methods onListAnalysesRequest.Builderto create a request.- Returns:
- Result of the ListAnalyses operation returned by the service.
- Throws:
ThrottlingException- Access is throttled.InvalidNextTokenException- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listAnalysesPaginator
default ListAnalysesIterable listAnalysesPaginator(ListAnalysesRequest listAnalysesRequest) throws ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listAnalyses(software.amazon.awssdk.services.quicksight.model.ListAnalysesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListAnalysesIterable responses = client.listAnalysesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListAnalysesIterable responses = client.listAnalysesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListAnalysesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListAnalysesIterable responses = client.listAnalysesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAnalyses(software.amazon.awssdk.services.quicksight.model.ListAnalysesRequest)operation.- Parameters:
listAnalysesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- Access is throttled.InvalidNextTokenException- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listAnalysesPaginator
default ListAnalysesIterable listAnalysesPaginator(Consumer<ListAnalysesRequest.Builder> listAnalysesRequest) throws ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listAnalyses(software.amazon.awssdk.services.quicksight.model.ListAnalysesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListAnalysesIterable responses = client.listAnalysesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListAnalysesIterable responses = client.listAnalysesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListAnalysesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListAnalysesIterable responses = client.listAnalysesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAnalyses(software.amazon.awssdk.services.quicksight.model.ListAnalysesRequest)operation.
This is a convenience which creates an instance of the
ListAnalysesRequest.Builderavoiding the need to create one manually viaListAnalysesRequest.builder()- Parameters:
listAnalysesRequest- AConsumerthat will call methods onListAnalysesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- Access is throttled.InvalidNextTokenException- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetBundleExportJobs
default ListAssetBundleExportJobsResponse listAssetBundleExportJobs(ListAssetBundleExportJobsRequest listAssetBundleExportJobsRequest) throws UnsupportedUserEditionException, ThrottlingException, AccessDeniedException, InvalidNextTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, QuickSightException
Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs,
ListAssetBundleExportJobsonly returns the most recent job that uses the repeated job ID.- Parameters:
listAssetBundleExportJobsRequest-- Returns:
- Result of the ListAssetBundleExportJobs operation returned by the service.
- Throws:
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 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetBundleExportJobs
default ListAssetBundleExportJobsResponse listAssetBundleExportJobs(Consumer<ListAssetBundleExportJobsRequest.Builder> listAssetBundleExportJobsRequest) throws UnsupportedUserEditionException, ThrottlingException, AccessDeniedException, InvalidNextTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, QuickSightException
Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs,
ListAssetBundleExportJobsonly returns the most recent job that uses the repeated job ID.
This is a convenience which creates an instance of the
ListAssetBundleExportJobsRequest.Builderavoiding the need to create one manually viaListAssetBundleExportJobsRequest.builder()- Parameters:
listAssetBundleExportJobsRequest- AConsumerthat will call methods onListAssetBundleExportJobsRequest.Builderto create a request.- Returns:
- Result of the ListAssetBundleExportJobs operation returned by the service.
- Throws:
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 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetBundleExportJobsPaginator
default ListAssetBundleExportJobsIterable listAssetBundleExportJobsPaginator(ListAssetBundleExportJobsRequest listAssetBundleExportJobsRequest) throws UnsupportedUserEditionException, ThrottlingException, AccessDeniedException, InvalidNextTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listAssetBundleExportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListAssetBundleExportJobsIterable responses = client.listAssetBundleExportJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListAssetBundleExportJobsIterable responses = client .listAssetBundleExportJobsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListAssetBundleExportJobsIterable responses = client.listAssetBundleExportJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssetBundleExportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsRequest)operation.- Parameters:
listAssetBundleExportJobsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetBundleExportJobsPaginator
default ListAssetBundleExportJobsIterable listAssetBundleExportJobsPaginator(Consumer<ListAssetBundleExportJobsRequest.Builder> listAssetBundleExportJobsRequest) throws UnsupportedUserEditionException, ThrottlingException, AccessDeniedException, InvalidNextTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listAssetBundleExportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListAssetBundleExportJobsIterable responses = client.listAssetBundleExportJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListAssetBundleExportJobsIterable responses = client .listAssetBundleExportJobsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListAssetBundleExportJobsIterable responses = client.listAssetBundleExportJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssetBundleExportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleExportJobsRequest)operation.
This is a convenience which creates an instance of the
ListAssetBundleExportJobsRequest.Builderavoiding the need to create one manually viaListAssetBundleExportJobsRequest.builder()- Parameters:
listAssetBundleExportJobsRequest- AConsumerthat will call methods onListAssetBundleExportJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetBundleImportJobs
default ListAssetBundleImportJobsResponse listAssetBundleImportJobs(ListAssetBundleImportJobsRequest listAssetBundleImportJobsRequest) throws UnsupportedUserEditionException, ThrottlingException, AccessDeniedException, InvalidNextTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, QuickSightException
Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs,
ListAssetBundleImportJobsonly returns the most recent job that uses the repeated job ID.- Parameters:
listAssetBundleImportJobsRequest-- Returns:
- Result of the ListAssetBundleImportJobs operation returned by the service.
- Throws:
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 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetBundleImportJobs
default ListAssetBundleImportJobsResponse listAssetBundleImportJobs(Consumer<ListAssetBundleImportJobsRequest.Builder> listAssetBundleImportJobsRequest) throws UnsupportedUserEditionException, ThrottlingException, AccessDeniedException, InvalidNextTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, QuickSightException
Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs,
ListAssetBundleImportJobsonly returns the most recent job that uses the repeated job ID.
This is a convenience which creates an instance of the
ListAssetBundleImportJobsRequest.Builderavoiding the need to create one manually viaListAssetBundleImportJobsRequest.builder()- Parameters:
listAssetBundleImportJobsRequest- AConsumerthat will call methods onListAssetBundleImportJobsRequest.Builderto create a request.- Returns:
- Result of the ListAssetBundleImportJobs operation returned by the service.
- Throws:
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 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetBundleImportJobsPaginator
default ListAssetBundleImportJobsIterable listAssetBundleImportJobsPaginator(ListAssetBundleImportJobsRequest listAssetBundleImportJobsRequest) throws UnsupportedUserEditionException, ThrottlingException, AccessDeniedException, InvalidNextTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listAssetBundleImportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListAssetBundleImportJobsIterable responses = client.listAssetBundleImportJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListAssetBundleImportJobsIterable responses = client .listAssetBundleImportJobsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListAssetBundleImportJobsIterable responses = client.listAssetBundleImportJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssetBundleImportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsRequest)operation.- Parameters:
listAssetBundleImportJobsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssetBundleImportJobsPaginator
default ListAssetBundleImportJobsIterable listAssetBundleImportJobsPaginator(Consumer<ListAssetBundleImportJobsRequest.Builder> listAssetBundleImportJobsRequest) throws UnsupportedUserEditionException, ThrottlingException, AccessDeniedException, InvalidNextTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listAssetBundleImportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListAssetBundleImportJobsIterable responses = client.listAssetBundleImportJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListAssetBundleImportJobsIterable responses = client .listAssetBundleImportJobsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListAssetBundleImportJobsIterable responses = client.listAssetBundleImportJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssetBundleImportJobs(software.amazon.awssdk.services.quicksight.model.ListAssetBundleImportJobsRequest)operation.
This is a convenience which creates an instance of the
ListAssetBundleImportJobsRequest.Builderavoiding the need to create one manually viaListAssetBundleImportJobsRequest.builder()- Parameters:
listAssetBundleImportJobsRequest- AConsumerthat will call methods onListAssetBundleImportJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listBrands
default ListBrandsResponse listBrands(ListBrandsRequest listBrandsRequest) throws ThrottlingException, InvalidRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, QuickSightException
Lists all brands in an QuickSight account.
- Parameters:
listBrandsRequest-- Returns:
- Result of the ListBrands operation returned by the service.
- Throws:
ThrottlingException- Access is throttled.InvalidRequestException- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.InternalServerException- An internal service exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listBrands
default ListBrandsResponse listBrands(Consumer<ListBrandsRequest.Builder> listBrandsRequest) throws ThrottlingException, InvalidRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, QuickSightException
Lists all brands in an QuickSight account.
This is a convenience which creates an instance of the
ListBrandsRequest.Builderavoiding the need to create one manually viaListBrandsRequest.builder()- Parameters:
listBrandsRequest- AConsumerthat will call methods onListBrandsRequest.Builderto create a request.- Returns:
- Result of the ListBrands operation returned by the service.
- Throws:
ThrottlingException- Access is throttled.InvalidRequestException- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.InternalServerException- An internal service exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listBrandsPaginator
default ListBrandsIterable listBrandsPaginator(ListBrandsRequest listBrandsRequest) throws ThrottlingException, InvalidRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listBrands(software.amazon.awssdk.services.quicksight.model.ListBrandsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListBrandsIterable responses = client.listBrandsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListBrandsIterable responses = client.listBrandsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListBrandsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListBrandsIterable responses = client.listBrandsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBrands(software.amazon.awssdk.services.quicksight.model.ListBrandsRequest)operation.- Parameters:
listBrandsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- Access is throttled.InvalidRequestException- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.InternalServerException- An internal service exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listBrandsPaginator
default ListBrandsIterable listBrandsPaginator(Consumer<ListBrandsRequest.Builder> listBrandsRequest) throws ThrottlingException, InvalidRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listBrands(software.amazon.awssdk.services.quicksight.model.ListBrandsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListBrandsIterable responses = client.listBrandsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListBrandsIterable responses = client.listBrandsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListBrandsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListBrandsIterable responses = client.listBrandsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBrands(software.amazon.awssdk.services.quicksight.model.ListBrandsRequest)operation.
This is a convenience which creates an instance of the
ListBrandsRequest.Builderavoiding the need to create one manually viaListBrandsRequest.builder()- Parameters:
listBrandsRequest- AConsumerthat will call methods onListBrandsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- Access is throttled.InvalidRequestException- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.InternalServerException- An internal service exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listCustomPermissions
default ListCustomPermissionsResponse listCustomPermissions(ListCustomPermissionsRequest listCustomPermissionsRequest) throws AccessDeniedException, ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Returns a list of all the custom permissions profiles.
- Parameters:
listCustomPermissionsRequest-- Returns:
- Result of the ListCustomPermissions operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.InvalidParameterValueException- One or more parameters has a value that isn't valid.ThrottlingException- Access is throttled.PreconditionNotMetException- One or more preconditions aren't met.InternalFailureException- An internal failure occurred.ResourceUnavailableException- This resource is currently unavailable.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listCustomPermissions
default ListCustomPermissionsResponse listCustomPermissions(Consumer<ListCustomPermissionsRequest.Builder> listCustomPermissionsRequest) throws AccessDeniedException, ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Returns a list of all the custom permissions profiles.
This is a convenience which creates an instance of the
ListCustomPermissionsRequest.Builderavoiding the need to create one manually viaListCustomPermissionsRequest.builder()- Parameters:
listCustomPermissionsRequest- AConsumerthat will call methods onListCustomPermissionsRequest.Builderto create a request.- Returns:
- Result of the ListCustomPermissions operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.InvalidParameterValueException- One or more parameters has a value that isn't valid.ThrottlingException- Access is throttled.PreconditionNotMetException- One or more preconditions aren't met.InternalFailureException- An internal failure occurred.ResourceUnavailableException- This resource is currently unavailable.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listCustomPermissionsPaginator
default ListCustomPermissionsIterable listCustomPermissionsPaginator(ListCustomPermissionsRequest listCustomPermissionsRequest) throws AccessDeniedException, ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listCustomPermissions(software.amazon.awssdk.services.quicksight.model.ListCustomPermissionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListCustomPermissionsIterable responses = client.listCustomPermissionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListCustomPermissionsIterable responses = client .listCustomPermissionsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListCustomPermissionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListCustomPermissionsIterable responses = client.listCustomPermissionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCustomPermissions(software.amazon.awssdk.services.quicksight.model.ListCustomPermissionsRequest)operation.- Parameters:
listCustomPermissionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.InvalidParameterValueException- One or more parameters has a value that isn't valid.ThrottlingException- Access is throttled.PreconditionNotMetException- One or more preconditions aren't met.InternalFailureException- An internal failure occurred.ResourceUnavailableException- This resource is currently unavailable.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listCustomPermissionsPaginator
default ListCustomPermissionsIterable listCustomPermissionsPaginator(Consumer<ListCustomPermissionsRequest.Builder> listCustomPermissionsRequest) throws AccessDeniedException, ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listCustomPermissions(software.amazon.awssdk.services.quicksight.model.ListCustomPermissionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListCustomPermissionsIterable responses = client.listCustomPermissionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListCustomPermissionsIterable responses = client .listCustomPermissionsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListCustomPermissionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListCustomPermissionsIterable responses = client.listCustomPermissionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCustomPermissions(software.amazon.awssdk.services.quicksight.model.ListCustomPermissionsRequest)operation.
This is a convenience which creates an instance of the
ListCustomPermissionsRequest.Builderavoiding the need to create one manually viaListCustomPermissionsRequest.builder()- Parameters:
listCustomPermissionsRequest- AConsumerthat will call methods onListCustomPermissionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.InvalidParameterValueException- One or more parameters has a value that isn't valid.ThrottlingException- Access is throttled.PreconditionNotMetException- One or more preconditions aren't met.InternalFailureException- An internal failure occurred.ResourceUnavailableException- This resource is currently unavailable.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listDashboardVersions
default ListDashboardVersionsResponse listDashboardVersions(ListDashboardVersionsRequest listDashboardVersionsRequest) throws InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the versions of the dashboards in the QuickSight subscription.
- Parameters:
listDashboardVersionsRequest-- Returns:
- Result of the ListDashboardVersions operation returned by the service.
- Throws:
InvalidParameterValueException- 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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listDashboardVersions
default ListDashboardVersionsResponse listDashboardVersions(Consumer<ListDashboardVersionsRequest.Builder> listDashboardVersionsRequest) throws InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the versions of the dashboards in the QuickSight subscription.
This is a convenience which creates an instance of the
ListDashboardVersionsRequest.Builderavoiding the need to create one manually viaListDashboardVersionsRequest.builder()- Parameters:
listDashboardVersionsRequest- AConsumerthat will call methods onListDashboardVersionsRequest.Builderto create a request.- Returns:
- Result of the ListDashboardVersions operation returned by the service.
- Throws:
InvalidParameterValueException- 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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listDashboardVersionsPaginator
default ListDashboardVersionsIterable listDashboardVersionsPaginator(ListDashboardVersionsRequest listDashboardVersionsRequest) throws InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsIterable responses = client.listDashboardVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsIterable responses = client .listDashboardVersionsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsIterable responses = client.listDashboardVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest)operation.- Parameters:
listDashboardVersionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidParameterValueException- 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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listDashboardVersionsPaginator
default ListDashboardVersionsIterable listDashboardVersionsPaginator(Consumer<ListDashboardVersionsRequest.Builder> listDashboardVersionsRequest) throws InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsIterable responses = client.listDashboardVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsIterable responses = client .listDashboardVersionsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListDashboardVersionsIterable responses = client.listDashboardVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDashboardVersions(software.amazon.awssdk.services.quicksight.model.ListDashboardVersionsRequest)operation.
This is a convenience which creates an instance of the
ListDashboardVersionsRequest.Builderavoiding the need to create one manually viaListDashboardVersionsRequest.builder()- Parameters:
listDashboardVersionsRequest- AConsumerthat will call methods onListDashboardVersionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidParameterValueException- 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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listDashboards
default ListDashboardsResponse listDashboards(ListDashboardsRequest listDashboardsRequest) throws ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists dashboards in an Amazon Web Services account.
- Parameters:
listDashboardsRequest-- Returns:
- Result of the ListDashboards operation returned by the service.
- Throws:
ThrottlingException- Access is throttled.InvalidNextTokenException- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listDashboards
default ListDashboardsResponse listDashboards(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest) throws ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists dashboards in an Amazon Web Services account.
This is a convenience which creates an instance of the
ListDashboardsRequest.Builderavoiding the need to create one manually viaListDashboardsRequest.builder()- Parameters:
listDashboardsRequest- AConsumerthat will call methods onListDashboardsRequest.Builderto create a request.- Returns:
- Result of the ListDashboards operation returned by the service.
- Throws:
ThrottlingException- Access is throttled.InvalidNextTokenException- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listDashboardsPaginator
default ListDashboardsIterable listDashboardsPaginator(ListDashboardsRequest listDashboardsRequest) throws ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListDashboardsIterable responses = client .listDashboardsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListDashboardsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest)operation.- Parameters:
listDashboardsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- Access is throttled.InvalidNextTokenException- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listDashboardsPaginator
default ListDashboardsIterable listDashboardsPaginator(Consumer<ListDashboardsRequest.Builder> listDashboardsRequest) throws ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListDashboardsIterable responses = client .listDashboardsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListDashboardsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListDashboardsIterable responses = client.listDashboardsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDashboards(software.amazon.awssdk.services.quicksight.model.ListDashboardsRequest)operation.
This is a convenience which creates an instance of the
ListDashboardsRequest.Builderavoiding the need to create one manually viaListDashboardsRequest.builder()- Parameters:
listDashboardsRequest- AConsumerthat will call methods onListDashboardsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ThrottlingException- Access is throttled.InvalidNextTokenException- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listDataSets
default ListDataSetsResponse listDataSets(ListDataSetsRequest listDataSetsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
The permissions resource is
arn:aws:quicksight:region:aws-account-id:dataset/*.- Parameters:
listDataSetsRequest-- Returns:
- Result of the ListDataSets operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listDataSets
default ListDataSetsResponse listDataSets(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
The permissions resource is
arn:aws:quicksight:region:aws-account-id:dataset/*.
This is a convenience which creates an instance of the
ListDataSetsRequest.Builderavoiding the need to create one manually viaListDataSetsRequest.builder()- Parameters:
listDataSetsRequest- AConsumerthat will call methods onListDataSetsRequest.Builderto create a request.- Returns:
- Result of the ListDataSets operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listDataSetsPaginator
default ListDataSetsIterable listDataSetsPaginator(ListDataSetsRequest listDataSetsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListDataSetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest)operation.- Parameters:
listDataSetsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listDataSetsPaginator
default ListDataSetsIterable listDataSetsPaginator(Consumer<ListDataSetsRequest.Builder> listDataSetsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListDataSetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListDataSetsIterable responses = client.listDataSetsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSets(software.amazon.awssdk.services.quicksight.model.ListDataSetsRequest)operation.
This is a convenience which creates an instance of the
ListDataSetsRequest.Builderavoiding the need to create one manually viaListDataSetsRequest.builder()- Parameters:
listDataSetsRequest- AConsumerthat will call methods onListDataSetsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listDataSources
default ListDataSourcesResponse listDataSources(ListDataSourcesRequest listDataSourcesRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
- Parameters:
listDataSourcesRequest-- Returns:
- Result of the ListDataSources operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listDataSources
default ListDataSourcesResponse listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
This is a convenience which creates an instance of the
ListDataSourcesRequest.Builderavoiding the need to create one manually viaListDataSourcesRequest.builder()- Parameters:
listDataSourcesRequest- AConsumerthat will call methods onListDataSourcesRequest.Builderto create a request.- Returns:
- Result of the ListDataSources operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listDataSourcesPaginator
default ListDataSourcesIterable listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesIterable responses = client .listDataSourcesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListDataSourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest)operation.- Parameters:
listDataSourcesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listDataSourcesPaginator
default ListDataSourcesIterable listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListDataSourcesIterable responses = client .listDataSourcesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListDataSourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSources(software.amazon.awssdk.services.quicksight.model.ListDataSourcesRequest)operation.
This is a convenience which creates an instance of the
ListDataSourcesRequest.Builderavoiding the need to create one manually viaListDataSourcesRequest.builder()- Parameters:
listDataSourcesRequest- AConsumerthat will call methods onListDataSourcesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listFolderMembers
default ListFolderMembersResponse listFolderMembers(ListFolderMembersRequest listFolderMembersRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
List all assets (
DASHBOARD,ANALYSIS, andDATASET) in a folder.- Parameters:
listFolderMembersRequest-- Returns:
- Result of the ListFolderMembers operation returned by the service.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listFolderMembers
default ListFolderMembersResponse listFolderMembers(Consumer<ListFolderMembersRequest.Builder> listFolderMembersRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
List all assets (
DASHBOARD,ANALYSIS, andDATASET) in a folder.
This is a convenience which creates an instance of the
ListFolderMembersRequest.Builderavoiding the need to create one manually viaListFolderMembersRequest.builder()- Parameters:
listFolderMembersRequest- AConsumerthat will call methods onListFolderMembersRequest.Builderto create a request.- Returns:
- Result of the ListFolderMembers operation returned by the service.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listFolderMembersPaginator
default ListFolderMembersIterable listFolderMembersPaginator(ListFolderMembersRequest listFolderMembersRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listFolderMembers(software.amazon.awssdk.services.quicksight.model.ListFolderMembersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListFolderMembersIterable responses = client.listFolderMembersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListFolderMembersIterable responses = client .listFolderMembersPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListFolderMembersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListFolderMembersIterable responses = client.listFolderMembersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFolderMembers(software.amazon.awssdk.services.quicksight.model.ListFolderMembersRequest)operation.- Parameters:
listFolderMembersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listFolderMembersPaginator
default ListFolderMembersIterable listFolderMembersPaginator(Consumer<ListFolderMembersRequest.Builder> listFolderMembersRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listFolderMembers(software.amazon.awssdk.services.quicksight.model.ListFolderMembersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListFolderMembersIterable responses = client.listFolderMembersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListFolderMembersIterable responses = client .listFolderMembersPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListFolderMembersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListFolderMembersIterable responses = client.listFolderMembersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFolderMembers(software.amazon.awssdk.services.quicksight.model.ListFolderMembersRequest)operation.
This is a convenience which creates an instance of the
ListFolderMembersRequest.Builderavoiding the need to create one manually viaListFolderMembersRequest.builder()- Parameters:
listFolderMembersRequest- AConsumerthat will call methods onListFolderMembersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listFolders
default ListFoldersResponse listFolders(ListFoldersRequest listFoldersRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all folders in an account.
- Parameters:
listFoldersRequest-- Returns:
- Result of the ListFolders operation returned by the service.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listFolders
default ListFoldersResponse listFolders(Consumer<ListFoldersRequest.Builder> listFoldersRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all folders in an account.
This is a convenience which creates an instance of the
ListFoldersRequest.Builderavoiding the need to create one manually viaListFoldersRequest.builder()- Parameters:
listFoldersRequest- AConsumerthat will call methods onListFoldersRequest.Builderto create a request.- Returns:
- Result of the ListFolders operation returned by the service.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listFoldersPaginator
default ListFoldersIterable listFoldersPaginator(ListFoldersRequest listFoldersRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listFolders(software.amazon.awssdk.services.quicksight.model.ListFoldersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListFoldersIterable responses = client.listFoldersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListFoldersIterable responses = client.listFoldersPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListFoldersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListFoldersIterable responses = client.listFoldersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFolders(software.amazon.awssdk.services.quicksight.model.ListFoldersRequest)operation.- Parameters:
listFoldersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listFoldersPaginator
default ListFoldersIterable listFoldersPaginator(Consumer<ListFoldersRequest.Builder> listFoldersRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listFolders(software.amazon.awssdk.services.quicksight.model.ListFoldersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListFoldersIterable responses = client.listFoldersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListFoldersIterable responses = client.listFoldersPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListFoldersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListFoldersIterable responses = client.listFoldersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFolders(software.amazon.awssdk.services.quicksight.model.ListFoldersRequest)operation.
This is a convenience which creates an instance of the
ListFoldersRequest.Builderavoiding the need to create one manually viaListFoldersRequest.builder()- Parameters:
listFoldersRequest- AConsumerthat will call methods onListFoldersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listFoldersForResource
default ListFoldersForResourceResponse listFoldersForResource(ListFoldersForResourceRequest listFoldersForResourceRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
List all folders that a resource is a member of.
- Parameters:
listFoldersForResourceRequest-- Returns:
- Result of the ListFoldersForResource operation returned by the service.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listFoldersForResource
default ListFoldersForResourceResponse listFoldersForResource(Consumer<ListFoldersForResourceRequest.Builder> listFoldersForResourceRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
List all folders that a resource is a member of.
This is a convenience which creates an instance of the
ListFoldersForResourceRequest.Builderavoiding the need to create one manually viaListFoldersForResourceRequest.builder()- Parameters:
listFoldersForResourceRequest- AConsumerthat will call methods onListFoldersForResourceRequest.Builderto create a request.- Returns:
- Result of the ListFoldersForResource operation returned by the service.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listFoldersForResourcePaginator
default ListFoldersForResourceIterable listFoldersForResourcePaginator(ListFoldersForResourceRequest listFoldersForResourceRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listFoldersForResource(software.amazon.awssdk.services.quicksight.model.ListFoldersForResourceRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListFoldersForResourceIterable responses = client.listFoldersForResourcePaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListFoldersForResourceIterable responses = client .listFoldersForResourcePaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListFoldersForResourceResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListFoldersForResourceIterable responses = client.listFoldersForResourcePaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFoldersForResource(software.amazon.awssdk.services.quicksight.model.ListFoldersForResourceRequest)operation.- Parameters:
listFoldersForResourceRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listFoldersForResourcePaginator
default ListFoldersForResourceIterable listFoldersForResourcePaginator(Consumer<ListFoldersForResourceRequest.Builder> listFoldersForResourceRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listFoldersForResource(software.amazon.awssdk.services.quicksight.model.ListFoldersForResourceRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListFoldersForResourceIterable responses = client.listFoldersForResourcePaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListFoldersForResourceIterable responses = client .listFoldersForResourcePaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListFoldersForResourceResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListFoldersForResourceIterable responses = client.listFoldersForResourcePaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFoldersForResource(software.amazon.awssdk.services.quicksight.model.ListFoldersForResourceRequest)operation.
This is a convenience which creates an instance of the
ListFoldersForResourceRequest.Builderavoiding the need to create one manually viaListFoldersForResourceRequest.builder()- Parameters:
listFoldersForResourceRequest- AConsumerthat will call methods onListFoldersForResourceRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupMemberships
default ListGroupMembershipsResponse listGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Lists member users in a group.
- Parameters:
listGroupMembershipsRequest-- Returns:
- Result of the ListGroupMemberships operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupMemberships
default ListGroupMembershipsResponse listGroupMemberships(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Lists member users in a group.
This is a convenience which creates an instance of the
ListGroupMembershipsRequest.Builderavoiding the need to create one manually viaListGroupMembershipsRequest.builder()- Parameters:
listGroupMembershipsRequest- AConsumerthat will call methods onListGroupMembershipsRequest.Builderto create a request.- Returns:
- Result of the ListGroupMemberships operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupMembershipsPaginator
default ListGroupMembershipsIterable listGroupMembershipsPaginator(ListGroupMembershipsRequest listGroupMembershipsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listGroupMemberships(software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListGroupMembershipsIterable responses = client.listGroupMembershipsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListGroupMembershipsIterable responses = client .listGroupMembershipsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListGroupMembershipsIterable responses = client.listGroupMembershipsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroupMemberships(software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsRequest)operation.- Parameters:
listGroupMembershipsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupMembershipsPaginator
default ListGroupMembershipsIterable listGroupMembershipsPaginator(Consumer<ListGroupMembershipsRequest.Builder> listGroupMembershipsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listGroupMemberships(software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListGroupMembershipsIterable responses = client.listGroupMembershipsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListGroupMembershipsIterable responses = client .listGroupMembershipsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListGroupMembershipsIterable responses = client.listGroupMembershipsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroupMemberships(software.amazon.awssdk.services.quicksight.model.ListGroupMembershipsRequest)operation.
This is a convenience which creates an instance of the
ListGroupMembershipsRequest.Builderavoiding the need to create one manually viaListGroupMembershipsRequest.builder()- Parameters:
listGroupMembershipsRequest- AConsumerthat will call methods onListGroupMembershipsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listGroups
default ListGroupsResponse listGroups(ListGroupsRequest listGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Lists all user groups in Amazon QuickSight.
- Parameters:
listGroupsRequest-- Returns:
- Result of the ListGroups operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listGroups
default ListGroupsResponse listGroups(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Lists all user groups in Amazon QuickSight.
This is a convenience which creates an instance of the
ListGroupsRequest.Builderavoiding the need to create one manually viaListGroupsRequest.builder()- Parameters:
listGroupsRequest- AConsumerthat will call methods onListGroupsRequest.Builderto create a request.- Returns:
- Result of the ListGroups operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupsPaginator
default ListGroupsIterable listGroupsPaginator(ListGroupsRequest listGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listGroups(software.amazon.awssdk.services.quicksight.model.ListGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.quicksight.model.ListGroupsRequest)operation.- Parameters:
listGroupsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listGroupsPaginator
default ListGroupsIterable listGroupsPaginator(Consumer<ListGroupsRequest.Builder> listGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listGroups(software.amazon.awssdk.services.quicksight.model.ListGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroups(software.amazon.awssdk.services.quicksight.model.ListGroupsRequest)operation.
This is a convenience which creates an instance of the
ListGroupsRequest.Builderavoiding the need to create one manually viaListGroupsRequest.builder()- Parameters:
listGroupsRequest- AConsumerthat will call methods onListGroupsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listIAMPolicyAssignments
default ListIamPolicyAssignmentsResponse listIAMPolicyAssignments(ListIamPolicyAssignmentsRequest listIamPolicyAssignmentsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists the IAM policy assignments in the current Amazon QuickSight account.
- Parameters:
listIamPolicyAssignmentsRequest-- Returns:
- Result of the ListIAMPolicyAssignments operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listIAMPolicyAssignments
default ListIamPolicyAssignmentsResponse listIAMPolicyAssignments(Consumer<ListIamPolicyAssignmentsRequest.Builder> listIamPolicyAssignmentsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists the IAM policy assignments in the current Amazon QuickSight account.
This is a convenience which creates an instance of the
ListIamPolicyAssignmentsRequest.Builderavoiding the need to create one manually viaListIamPolicyAssignmentsRequest.builder()- Parameters:
listIamPolicyAssignmentsRequest- AConsumerthat will call methods onListIamPolicyAssignmentsRequest.Builderto create a request.- Returns:
- Result of the ListIAMPolicyAssignments operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listIAMPolicyAssignmentsPaginator
default ListIAMPolicyAssignmentsIterable listIAMPolicyAssignmentsPaginator(ListIamPolicyAssignmentsRequest listIamPolicyAssignmentsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listIAMPolicyAssignments(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsIterable responses = client.listIAMPolicyAssignmentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsIterable responses = client .listIAMPolicyAssignmentsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsIterable responses = client.listIAMPolicyAssignmentsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIAMPolicyAssignments(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsRequest)operation.- Parameters:
listIamPolicyAssignmentsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listIAMPolicyAssignmentsPaginator
default ListIAMPolicyAssignmentsIterable listIAMPolicyAssignmentsPaginator(Consumer<ListIamPolicyAssignmentsRequest.Builder> listIamPolicyAssignmentsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listIAMPolicyAssignments(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsIterable responses = client.listIAMPolicyAssignmentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsIterable responses = client .listIAMPolicyAssignmentsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsIterable responses = client.listIAMPolicyAssignmentsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIAMPolicyAssignments(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsRequest)operation.
This is a convenience which creates an instance of the
ListIamPolicyAssignmentsRequest.Builderavoiding the need to create one manually viaListIamPolicyAssignmentsRequest.builder()- Parameters:
listIamPolicyAssignmentsRequest- AConsumerthat will call methods onListIamPolicyAssignmentsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listIAMPolicyAssignmentsForUser
default ListIamPolicyAssignmentsForUserResponse listIAMPolicyAssignmentsForUser(ListIamPolicyAssignmentsForUserRequest listIamPolicyAssignmentsForUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConcurrentUpdatingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to.
- Parameters:
listIamPolicyAssignmentsForUserRequest-- Returns:
- Result of the ListIAMPolicyAssignmentsForUser operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
listIAMPolicyAssignmentsForUser
default ListIamPolicyAssignmentsForUserResponse listIAMPolicyAssignmentsForUser(Consumer<ListIamPolicyAssignmentsForUserRequest.Builder> listIamPolicyAssignmentsForUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConcurrentUpdatingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to.
This is a convenience which creates an instance of the
ListIamPolicyAssignmentsForUserRequest.Builderavoiding the need to create one manually viaListIamPolicyAssignmentsForUserRequest.builder()- Parameters:
listIamPolicyAssignmentsForUserRequest- AConsumerthat will call methods onListIamPolicyAssignmentsForUserRequest.Builderto create a request.- Returns:
- Result of the ListIAMPolicyAssignmentsForUser operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
listIAMPolicyAssignmentsForUserPaginator
default ListIAMPolicyAssignmentsForUserIterable listIAMPolicyAssignmentsForUserPaginator(ListIamPolicyAssignmentsForUserRequest listIamPolicyAssignmentsForUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConcurrentUpdatingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listIAMPolicyAssignmentsForUser(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsForUserIterable responses = client.listIAMPolicyAssignmentsForUserPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsForUserIterable responses = client .listIAMPolicyAssignmentsForUserPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsForUserIterable responses = client.listIAMPolicyAssignmentsForUserPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIAMPolicyAssignmentsForUser(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserRequest)operation.- Parameters:
listIamPolicyAssignmentsForUserRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
listIAMPolicyAssignmentsForUserPaginator
default ListIAMPolicyAssignmentsForUserIterable listIAMPolicyAssignmentsForUserPaginator(Consumer<ListIamPolicyAssignmentsForUserRequest.Builder> listIamPolicyAssignmentsForUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConcurrentUpdatingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listIAMPolicyAssignmentsForUser(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsForUserIterable responses = client.listIAMPolicyAssignmentsForUserPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsForUserIterable responses = client .listIAMPolicyAssignmentsForUserPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListIAMPolicyAssignmentsForUserIterable responses = client.listIAMPolicyAssignmentsForUserPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIAMPolicyAssignmentsForUser(software.amazon.awssdk.services.quicksight.model.ListIamPolicyAssignmentsForUserRequest)operation.
This is a convenience which creates an instance of the
ListIamPolicyAssignmentsForUserRequest.Builderavoiding the need to create one manually viaListIamPolicyAssignmentsForUserRequest.builder()- Parameters:
listIamPolicyAssignmentsForUserRequest- AConsumerthat will call methods onListIamPolicyAssignmentsForUserRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
listIdentityPropagationConfigs
default ListIdentityPropagationConfigsResponse listIdentityPropagationConfigs(ListIdentityPropagationConfigsRequest listIdentityPropagationConfigsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all services and authorized targets that the QuickSight IAM Identity Center application can access.
This operation is only supported for QuickSight accounts that use IAM Identity Center.
- Parameters:
listIdentityPropagationConfigsRequest-- Returns:
- Result of the ListIdentityPropagationConfigs operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
listIdentityPropagationConfigs
default ListIdentityPropagationConfigsResponse listIdentityPropagationConfigs(Consumer<ListIdentityPropagationConfigsRequest.Builder> listIdentityPropagationConfigsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all services and authorized targets that the QuickSight IAM Identity Center application can access.
This operation is only supported for QuickSight accounts that use IAM Identity Center.
This is a convenience which creates an instance of the
ListIdentityPropagationConfigsRequest.Builderavoiding the need to create one manually viaListIdentityPropagationConfigsRequest.builder()- Parameters:
listIdentityPropagationConfigsRequest- AConsumerthat will call methods onListIdentityPropagationConfigsRequest.Builderto create a request.- Returns:
- Result of the ListIdentityPropagationConfigs operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
listIngestions
default ListIngestionsResponse listIngestions(ListIngestionsRequest listIngestionsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ResourceExistsException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists the history of SPICE ingestions for a dataset. Limited to 5 TPS per user and 25 TPS per account.
- Parameters:
listIngestionsRequest-- Returns:
- Result of the ListIngestions operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listIngestions
default ListIngestionsResponse listIngestions(Consumer<ListIngestionsRequest.Builder> listIngestionsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ResourceExistsException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists the history of SPICE ingestions for a dataset. Limited to 5 TPS per user and 25 TPS per account.
This is a convenience which creates an instance of the
ListIngestionsRequest.Builderavoiding the need to create one manually viaListIngestionsRequest.builder()- Parameters:
listIngestionsRequest- AConsumerthat will call methods onListIngestionsRequest.Builderto create a request.- Returns:
- Result of the ListIngestions operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listIngestionsPaginator
default ListIngestionsIterable listIngestionsPaginator(ListIngestionsRequest listIngestionsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ResourceExistsException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listIngestions(software.amazon.awssdk.services.quicksight.model.ListIngestionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListIngestionsIterable responses = client.listIngestionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListIngestionsIterable responses = client .listIngestionsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListIngestionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListIngestionsIterable responses = client.listIngestionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIngestions(software.amazon.awssdk.services.quicksight.model.ListIngestionsRequest)operation.- Parameters:
listIngestionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listIngestionsPaginator
default ListIngestionsIterable listIngestionsPaginator(Consumer<ListIngestionsRequest.Builder> listIngestionsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, ResourceExistsException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listIngestions(software.amazon.awssdk.services.quicksight.model.ListIngestionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListIngestionsIterable responses = client.listIngestionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListIngestionsIterable responses = client .listIngestionsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListIngestionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListIngestionsIterable responses = client.listIngestionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIngestions(software.amazon.awssdk.services.quicksight.model.ListIngestionsRequest)operation.
This is a convenience which creates an instance of the
ListIngestionsRequest.Builderavoiding the need to create one manually viaListIngestionsRequest.builder()- Parameters:
listIngestionsRequest- AConsumerthat will call methods onListIngestionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listNamespaces
default ListNamespacesResponse listNamespaces(ListNamespacesRequest listNamespacesRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.
- Parameters:
listNamespacesRequest-- Returns:
- Result of the ListNamespaces operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listNamespaces
default ListNamespacesResponse listNamespaces(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.
This is a convenience which creates an instance of the
ListNamespacesRequest.Builderavoiding the need to create one manually viaListNamespacesRequest.builder()- Parameters:
listNamespacesRequest- AConsumerthat will call methods onListNamespacesRequest.Builderto create a request.- Returns:
- Result of the ListNamespaces operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listNamespacesPaginator
default ListNamespacesIterable listNamespacesPaginator(ListNamespacesRequest listNamespacesRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listNamespaces(software.amazon.awssdk.services.quicksight.model.ListNamespacesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListNamespacesIterable responses = client.listNamespacesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListNamespacesIterable responses = client .listNamespacesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListNamespacesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListNamespacesIterable responses = client.listNamespacesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNamespaces(software.amazon.awssdk.services.quicksight.model.ListNamespacesRequest)operation.- Parameters:
listNamespacesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listNamespacesPaginator
default ListNamespacesIterable listNamespacesPaginator(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listNamespaces(software.amazon.awssdk.services.quicksight.model.ListNamespacesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListNamespacesIterable responses = client.listNamespacesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListNamespacesIterable responses = client .listNamespacesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListNamespacesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListNamespacesIterable responses = client.listNamespacesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNamespaces(software.amazon.awssdk.services.quicksight.model.ListNamespacesRequest)operation.
This is a convenience which creates an instance of the
ListNamespacesRequest.Builderavoiding the need to create one manually viaListNamespacesRequest.builder()- Parameters:
listNamespacesRequest- AConsumerthat will call methods onListNamespacesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listRefreshSchedules
default ListRefreshSchedulesResponse listRefreshSchedules(ListRefreshSchedulesRequest listRefreshSchedulesRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.
- Parameters:
listRefreshSchedulesRequest-- Returns:
- Result of the ListRefreshSchedules operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
listRefreshSchedules
default ListRefreshSchedulesResponse listRefreshSchedules(Consumer<ListRefreshSchedulesRequest.Builder> listRefreshSchedulesRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.
This is a convenience which creates an instance of the
ListRefreshSchedulesRequest.Builderavoiding the need to create one manually viaListRefreshSchedulesRequest.builder()- Parameters:
listRefreshSchedulesRequest- AConsumerthat will call methods onListRefreshSchedulesRequest.Builderto create a request.- Returns:
- Result of the ListRefreshSchedules operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
listRoleMemberships
default ListRoleMembershipsResponse listRoleMemberships(ListRoleMembershipsRequest listRoleMembershipsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, LimitExceededException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Lists all groups that are associated with a role.
- Parameters:
listRoleMembershipsRequest-- Returns:
- Result of the ListRoleMemberships operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listRoleMemberships
default ListRoleMembershipsResponse listRoleMemberships(Consumer<ListRoleMembershipsRequest.Builder> listRoleMembershipsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, LimitExceededException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Lists all groups that are associated with a role.
This is a convenience which creates an instance of the
ListRoleMembershipsRequest.Builderavoiding the need to create one manually viaListRoleMembershipsRequest.builder()- Parameters:
listRoleMembershipsRequest- AConsumerthat will call methods onListRoleMembershipsRequest.Builderto create a request.- Returns:
- Result of the ListRoleMemberships operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listRoleMembershipsPaginator
default ListRoleMembershipsIterable listRoleMembershipsPaginator(ListRoleMembershipsRequest listRoleMembershipsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, LimitExceededException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listRoleMemberships(software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListRoleMembershipsIterable responses = client.listRoleMembershipsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListRoleMembershipsIterable responses = client .listRoleMembershipsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListRoleMembershipsIterable responses = client.listRoleMembershipsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRoleMemberships(software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsRequest)operation.- Parameters:
listRoleMembershipsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listRoleMembershipsPaginator
default ListRoleMembershipsIterable listRoleMembershipsPaginator(Consumer<ListRoleMembershipsRequest.Builder> listRoleMembershipsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, LimitExceededException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listRoleMemberships(software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListRoleMembershipsIterable responses = client.listRoleMembershipsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListRoleMembershipsIterable responses = client .listRoleMembershipsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListRoleMembershipsIterable responses = client.listRoleMembershipsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRoleMemberships(software.amazon.awssdk.services.quicksight.model.ListRoleMembershipsRequest)operation.
This is a convenience which creates an instance of the
ListRoleMembershipsRequest.Builderavoiding the need to create one manually viaListRoleMembershipsRequest.builder()- Parameters:
listRoleMembershipsRequest- AConsumerthat will call methods onListRoleMembershipsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists the tags assigned to a resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists the tags assigned to a resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplateAliases
default ListTemplateAliasesResponse listTemplateAliases(ListTemplateAliasesRequest listTemplateAliasesRequest) throws InvalidNextTokenException, ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the aliases of a template.
- Parameters:
listTemplateAliasesRequest-- Returns:
- Result of the ListTemplateAliases operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplateAliases
default ListTemplateAliasesResponse listTemplateAliases(Consumer<ListTemplateAliasesRequest.Builder> listTemplateAliasesRequest) throws InvalidNextTokenException, ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the aliases of a template.
This is a convenience which creates an instance of the
ListTemplateAliasesRequest.Builderavoiding the need to create one manually viaListTemplateAliasesRequest.builder()- Parameters:
listTemplateAliasesRequest- AConsumerthat will call methods onListTemplateAliasesRequest.Builderto create a request.- Returns:
- Result of the ListTemplateAliases operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplateAliasesPaginator
default ListTemplateAliasesIterable listTemplateAliasesPaginator(ListTemplateAliasesRequest listTemplateAliasesRequest) throws InvalidNextTokenException, ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listTemplateAliases(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesIterable responses = client.listTemplateAliasesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesIterable responses = client .listTemplateAliasesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesIterable responses = client.listTemplateAliasesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplateAliases(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesRequest)operation.- Parameters:
listTemplateAliasesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplateAliasesPaginator
default ListTemplateAliasesIterable listTemplateAliasesPaginator(Consumer<ListTemplateAliasesRequest.Builder> listTemplateAliasesRequest) throws InvalidNextTokenException, ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listTemplateAliases(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesIterable responses = client.listTemplateAliasesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesIterable responses = client .listTemplateAliasesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListTemplateAliasesIterable responses = client.listTemplateAliasesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplateAliases(software.amazon.awssdk.services.quicksight.model.ListTemplateAliasesRequest)operation.
This is a convenience which creates an instance of the
ListTemplateAliasesRequest.Builderavoiding the need to create one manually viaListTemplateAliasesRequest.builder()- Parameters:
listTemplateAliasesRequest- AConsumerthat will call methods onListTemplateAliasesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplateVersions
default ListTemplateVersionsResponse listTemplateVersions(ListTemplateVersionsRequest listTemplateVersionsRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the versions of the templates in the current Amazon QuickSight account.
- Parameters:
listTemplateVersionsRequest-- Returns:
- Result of the ListTemplateVersions operation returned by the service.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplateVersions
default ListTemplateVersionsResponse listTemplateVersions(Consumer<ListTemplateVersionsRequest.Builder> listTemplateVersionsRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the versions of the templates in the current Amazon QuickSight account.
This is a convenience which creates an instance of the
ListTemplateVersionsRequest.Builderavoiding the need to create one manually viaListTemplateVersionsRequest.builder()- Parameters:
listTemplateVersionsRequest- AConsumerthat will call methods onListTemplateVersionsRequest.Builderto create a request.- Returns:
- Result of the ListTemplateVersions operation returned by the service.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplateVersionsPaginator
default ListTemplateVersionsIterable listTemplateVersionsPaginator(ListTemplateVersionsRequest listTemplateVersionsRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listTemplateVersions(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsIterable responses = client.listTemplateVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsIterable responses = client .listTemplateVersionsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsIterable responses = client.listTemplateVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplateVersions(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsRequest)operation.- Parameters:
listTemplateVersionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplateVersionsPaginator
default ListTemplateVersionsIterable listTemplateVersionsPaginator(Consumer<ListTemplateVersionsRequest.Builder> listTemplateVersionsRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listTemplateVersions(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsIterable responses = client.listTemplateVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsIterable responses = client .listTemplateVersionsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListTemplateVersionsIterable responses = client.listTemplateVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplateVersions(software.amazon.awssdk.services.quicksight.model.ListTemplateVersionsRequest)operation.
This is a convenience which creates an instance of the
ListTemplateVersionsRequest.Builderavoiding the need to create one manually viaListTemplateVersionsRequest.builder()- Parameters:
listTemplateVersionsRequest- AConsumerthat will call methods onListTemplateVersionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplates
default ListTemplatesResponse listTemplates(ListTemplatesRequest listTemplatesRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the templates in the current Amazon QuickSight account.
- Parameters:
listTemplatesRequest-- Returns:
- Result of the ListTemplates operation returned by the service.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplates
default ListTemplatesResponse listTemplates(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the templates in the current Amazon QuickSight account.
This is a convenience which creates an instance of the
ListTemplatesRequest.Builderavoiding the need to create one manually viaListTemplatesRequest.builder()- Parameters:
listTemplatesRequest- AConsumerthat will call methods onListTemplatesRequest.Builderto create a request.- Returns:
- Result of the ListTemplates operation returned by the service.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplatesPaginator
default ListTemplatesIterable listTemplatesPaginator(ListTemplatesRequest listTemplatesRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listTemplates(software.amazon.awssdk.services.quicksight.model.ListTemplatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListTemplatesIterable responses = client .listTemplatesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListTemplatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplates(software.amazon.awssdk.services.quicksight.model.ListTemplatesRequest)operation.- Parameters:
listTemplatesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTemplatesPaginator
default ListTemplatesIterable listTemplatesPaginator(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listTemplates(software.amazon.awssdk.services.quicksight.model.ListTemplatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListTemplatesIterable responses = client .listTemplatesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListTemplatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListTemplatesIterable responses = client.listTemplatesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTemplates(software.amazon.awssdk.services.quicksight.model.ListTemplatesRequest)operation.
This is a convenience which creates an instance of the
ListTemplatesRequest.Builderavoiding the need to create one manually viaListTemplatesRequest.builder()- Parameters:
listTemplatesRequest- AConsumerthat will call methods onListTemplatesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listThemeAliases
default ListThemeAliasesResponse listThemeAliases(ListThemeAliasesRequest listThemeAliasesRequest) throws ConflictException, InvalidNextTokenException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the aliases of a theme.
- Parameters:
listThemeAliasesRequest-- Returns:
- Result of the ListThemeAliases operation returned by the service.
- Throws:
ConflictException- Updating or deleting a resource can cause an inconsistent state.InvalidNextTokenException- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listThemeAliases
default ListThemeAliasesResponse listThemeAliases(Consumer<ListThemeAliasesRequest.Builder> listThemeAliasesRequest) throws ConflictException, InvalidNextTokenException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the aliases of a theme.
This is a convenience which creates an instance of the
ListThemeAliasesRequest.Builderavoiding the need to create one manually viaListThemeAliasesRequest.builder()- Parameters:
listThemeAliasesRequest- AConsumerthat will call methods onListThemeAliasesRequest.Builderto create a request.- Returns:
- Result of the ListThemeAliases operation returned by the service.
- Throws:
ConflictException- Updating or deleting a resource can cause an inconsistent state.InvalidNextTokenException- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listThemeVersions
default ListThemeVersionsResponse listThemeVersions(ListThemeVersionsRequest listThemeVersionsRequest) throws AccessDeniedException, InvalidNextTokenException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the versions of the themes in the current Amazon Web Services account.
- Parameters:
listThemeVersionsRequest-- Returns:
- Result of the ListThemeVersions operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listThemeVersions
default ListThemeVersionsResponse listThemeVersions(Consumer<ListThemeVersionsRequest.Builder> listThemeVersionsRequest) throws AccessDeniedException, InvalidNextTokenException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the versions of the themes in the current Amazon Web Services account.
This is a convenience which creates an instance of the
ListThemeVersionsRequest.Builderavoiding the need to create one manually viaListThemeVersionsRequest.builder()- Parameters:
listThemeVersionsRequest- AConsumerthat will call methods onListThemeVersionsRequest.Builderto create a request.- Returns:
- Result of the ListThemeVersions operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listThemeVersionsPaginator
default ListThemeVersionsIterable listThemeVersionsPaginator(ListThemeVersionsRequest listThemeVersionsRequest) throws AccessDeniedException, InvalidNextTokenException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listThemeVersions(software.amazon.awssdk.services.quicksight.model.ListThemeVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListThemeVersionsIterable responses = client.listThemeVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListThemeVersionsIterable responses = client .listThemeVersionsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListThemeVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListThemeVersionsIterable responses = client.listThemeVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThemeVersions(software.amazon.awssdk.services.quicksight.model.ListThemeVersionsRequest)operation.- Parameters:
listThemeVersionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listThemeVersionsPaginator
default ListThemeVersionsIterable listThemeVersionsPaginator(Consumer<ListThemeVersionsRequest.Builder> listThemeVersionsRequest) throws AccessDeniedException, InvalidNextTokenException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listThemeVersions(software.amazon.awssdk.services.quicksight.model.ListThemeVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListThemeVersionsIterable responses = client.listThemeVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListThemeVersionsIterable responses = client .listThemeVersionsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListThemeVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListThemeVersionsIterable responses = client.listThemeVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThemeVersions(software.amazon.awssdk.services.quicksight.model.ListThemeVersionsRequest)operation.
This is a convenience which creates an instance of the
ListThemeVersionsRequest.Builderavoiding the need to create one manually viaListThemeVersionsRequest.builder()- Parameters:
listThemeVersionsRequest- AConsumerthat will call methods onListThemeVersionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listThemes
default ListThemesResponse listThemes(ListThemesRequest listThemesRequest) throws AccessDeniedException, InvalidParameterValueException, InvalidNextTokenException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the themes in the current Amazon Web Services account.
- Parameters:
listThemesRequest-- Returns:
- Result of the ListThemes operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listThemes
default ListThemesResponse listThemes(Consumer<ListThemesRequest.Builder> listThemesRequest) throws AccessDeniedException, InvalidParameterValueException, InvalidNextTokenException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all the themes in the current Amazon Web Services account.
This is a convenience which creates an instance of the
ListThemesRequest.Builderavoiding the need to create one manually viaListThemesRequest.builder()- Parameters:
listThemesRequest- AConsumerthat will call methods onListThemesRequest.Builderto create a request.- Returns:
- Result of the ListThemes operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listThemesPaginator
default ListThemesIterable listThemesPaginator(ListThemesRequest listThemesRequest) throws AccessDeniedException, InvalidParameterValueException, InvalidNextTokenException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listThemes(software.amazon.awssdk.services.quicksight.model.ListThemesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListThemesIterable responses = client.listThemesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListThemesIterable responses = client.listThemesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListThemesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListThemesIterable responses = client.listThemesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThemes(software.amazon.awssdk.services.quicksight.model.ListThemesRequest)operation.- Parameters:
listThemesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listThemesPaginator
default ListThemesIterable listThemesPaginator(Consumer<ListThemesRequest.Builder> listThemesRequest) throws AccessDeniedException, InvalidParameterValueException, InvalidNextTokenException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listThemes(software.amazon.awssdk.services.quicksight.model.ListThemesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListThemesIterable responses = client.listThemesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListThemesIterable responses = client.listThemesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListThemesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListThemesIterable responses = client.listThemesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThemes(software.amazon.awssdk.services.quicksight.model.ListThemesRequest)operation.
This is a convenience which creates an instance of the
ListThemesRequest.Builderavoiding the need to create one manually viaListThemesRequest.builder()- Parameters:
listThemesRequest- AConsumerthat will call methods onListThemesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTopicRefreshSchedules
default ListTopicRefreshSchedulesResponse listTopicRefreshSchedules(ListTopicRefreshSchedulesRequest listTopicRefreshSchedulesRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceNotFoundException, ResourceExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all of the refresh schedules for a topic.
- Parameters:
listTopicRefreshSchedulesRequest-- Returns:
- Result of the ListTopicRefreshSchedules operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTopicRefreshSchedules
default ListTopicRefreshSchedulesResponse listTopicRefreshSchedules(Consumer<ListTopicRefreshSchedulesRequest.Builder> listTopicRefreshSchedulesRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceNotFoundException, ResourceExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all of the refresh schedules for a topic.
This is a convenience which creates an instance of the
ListTopicRefreshSchedulesRequest.Builderavoiding the need to create one manually viaListTopicRefreshSchedulesRequest.builder()- Parameters:
listTopicRefreshSchedulesRequest- AConsumerthat will call methods onListTopicRefreshSchedulesRequest.Builderto create a request.- Returns:
- Result of the ListTopicRefreshSchedules operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTopicReviewedAnswers
default ListTopicReviewedAnswersResponse listTopicReviewedAnswers(ListTopicReviewedAnswersRequest listTopicReviewedAnswersRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all reviewed answers for a Q Topic.
- Parameters:
listTopicReviewedAnswersRequest-- Returns:
- Result of the ListTopicReviewedAnswers operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTopicReviewedAnswers
default ListTopicReviewedAnswersResponse listTopicReviewedAnswers(Consumer<ListTopicReviewedAnswersRequest.Builder> listTopicReviewedAnswersRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all reviewed answers for a Q Topic.
This is a convenience which creates an instance of the
ListTopicReviewedAnswersRequest.Builderavoiding the need to create one manually viaListTopicReviewedAnswersRequest.builder()- Parameters:
listTopicReviewedAnswersRequest- AConsumerthat will call methods onListTopicReviewedAnswersRequest.Builderto create a request.- Returns:
- Result of the ListTopicReviewedAnswers operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTopics
default ListTopicsResponse listTopics(ListTopicsRequest listTopicsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all of the topics within an account.
- Parameters:
listTopicsRequest-- Returns:
- Result of the ListTopics operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTopics
default ListTopicsResponse listTopics(Consumer<ListTopicsRequest.Builder> listTopicsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all of the topics within an account.
This is a convenience which creates an instance of the
ListTopicsRequest.Builderavoiding the need to create one manually viaListTopicsRequest.builder()- Parameters:
listTopicsRequest- AConsumerthat will call methods onListTopicsRequest.Builderto create a request.- Returns:
- Result of the ListTopics operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTopicsPaginator
default ListTopicsIterable listTopicsPaginator(ListTopicsRequest listTopicsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listTopics(software.amazon.awssdk.services.quicksight.model.ListTopicsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListTopicsIterable responses = client.listTopicsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListTopicsIterable responses = client.listTopicsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListTopicsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListTopicsIterable responses = client.listTopicsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTopics(software.amazon.awssdk.services.quicksight.model.ListTopicsRequest)operation.- Parameters:
listTopicsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTopicsPaginator
default ListTopicsIterable listTopicsPaginator(Consumer<ListTopicsRequest.Builder> listTopicsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listTopics(software.amazon.awssdk.services.quicksight.model.ListTopicsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListTopicsIterable responses = client.listTopicsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListTopicsIterable responses = client.listTopicsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListTopicsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListTopicsIterable responses = client.listTopicsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTopics(software.amazon.awssdk.services.quicksight.model.ListTopicsRequest)operation.
This is a convenience which creates an instance of the
ListTopicsRequest.Builderavoiding the need to create one manually viaListTopicsRequest.builder()- Parameters:
listTopicsRequest- AConsumerthat will call methods onListTopicsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listUserGroups
default ListUserGroupsResponse listUserGroups(ListUserGroupsRequest listUserGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
- Parameters:
listUserGroupsRequest-- Returns:
- Result of the ListUserGroups operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
listUserGroups
default ListUserGroupsResponse listUserGroups(Consumer<ListUserGroupsRequest.Builder> listUserGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
This is a convenience which creates an instance of the
ListUserGroupsRequest.Builderavoiding the need to create one manually viaListUserGroupsRequest.builder()- Parameters:
listUserGroupsRequest- AConsumerthat will call methods onListUserGroupsRequest.Builderto create a request.- Returns:
- Result of the ListUserGroups operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
listUserGroupsPaginator
default ListUserGroupsIterable listUserGroupsPaginator(ListUserGroupsRequest listUserGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listUserGroups(software.amazon.awssdk.services.quicksight.model.ListUserGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListUserGroupsIterable responses = client.listUserGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListUserGroupsIterable responses = client .listUserGroupsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListUserGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListUserGroupsIterable responses = client.listUserGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUserGroups(software.amazon.awssdk.services.quicksight.model.ListUserGroupsRequest)operation.- Parameters:
listUserGroupsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
listUserGroupsPaginator
default ListUserGroupsIterable listUserGroupsPaginator(Consumer<ListUserGroupsRequest.Builder> listUserGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listUserGroups(software.amazon.awssdk.services.quicksight.model.ListUserGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListUserGroupsIterable responses = client.listUserGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListUserGroupsIterable responses = client .listUserGroupsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListUserGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListUserGroupsIterable responses = client.listUserGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUserGroups(software.amazon.awssdk.services.quicksight.model.ListUserGroupsRequest)operation.
This is a convenience which creates an instance of the
ListUserGroupsRequest.Builderavoiding the need to create one manually viaListUserGroupsRequest.builder()- Parameters:
listUserGroupsRequest- AConsumerthat will call methods onListUserGroupsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
listUsers
default ListUsersResponse listUsers(ListUsersRequest listUsersRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Returns a list of all of the Amazon QuickSight users belonging to this account.
- Parameters:
listUsersRequest-- Returns:
- Result of the ListUsers operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listUsers
default ListUsersResponse listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Returns a list of all of the Amazon QuickSight users belonging to this account.
This is a convenience which creates an instance of the
ListUsersRequest.Builderavoiding the need to create one manually viaListUsersRequest.builder()- Parameters:
listUsersRequest- AConsumerthat will call methods onListUsersRequest.Builderto create a request.- Returns:
- Result of the ListUsers operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listUsersPaginator
default ListUsersIterable listUsersPaginator(ListUsersRequest listUsersRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listUsers(software.amazon.awssdk.services.quicksight.model.ListUsersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListUsersIterable responses = client.listUsersPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListUsersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.quicksight.model.ListUsersRequest)operation.- Parameters:
listUsersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listUsersPaginator
default ListUsersIterable listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listUsers(software.amazon.awssdk.services.quicksight.model.ListUsersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListUsersIterable responses = client.listUsersPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListUsersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.quicksight.model.ListUsersRequest)operation.
This is a convenience which creates an instance of the
ListUsersRequest.Builderavoiding the need to create one manually viaListUsersRequest.builder()- Parameters:
listUsersRequest- AConsumerthat will call methods onListUsersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
listVPCConnections
default ListVpcConnectionsResponse listVPCConnections(ListVpcConnectionsRequest listVpcConnectionsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
- Parameters:
listVpcConnectionsRequest-- Returns:
- Result of the ListVPCConnections operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listVPCConnections
default ListVpcConnectionsResponse listVPCConnections(Consumer<ListVpcConnectionsRequest.Builder> listVpcConnectionsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
This is a convenience which creates an instance of the
ListVpcConnectionsRequest.Builderavoiding the need to create one manually viaListVpcConnectionsRequest.builder()- Parameters:
listVpcConnectionsRequest- AConsumerthat will call methods onListVpcConnectionsRequest.Builderto create a request.- Returns:
- Result of the ListVPCConnections operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listVPCConnectionsPaginator
default ListVPCConnectionsIterable listVPCConnectionsPaginator(ListVpcConnectionsRequest listVpcConnectionsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listVPCConnections(software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListVPCConnectionsIterable responses = client.listVPCConnectionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListVPCConnectionsIterable responses = client .listVPCConnectionsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListVPCConnectionsIterable responses = client.listVPCConnectionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVPCConnections(software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsRequest)operation.- Parameters:
listVpcConnectionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
listVPCConnectionsPaginator
default ListVPCConnectionsIterable listVPCConnectionsPaginator(Consumer<ListVpcConnectionsRequest.Builder> listVpcConnectionsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
listVPCConnections(software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.ListVPCConnectionsIterable responses = client.listVPCConnectionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.ListVPCConnectionsIterable responses = client .listVPCConnectionsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.ListVPCConnectionsIterable responses = client.listVPCConnectionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVPCConnections(software.amazon.awssdk.services.quicksight.model.ListVpcConnectionsRequest)operation.
This is a convenience which creates an instance of the
ListVpcConnectionsRequest.Builderavoiding the need to create one manually viaListVpcConnectionsRequest.builder()- Parameters:
listVpcConnectionsRequest- AConsumerthat will call methods onListVpcConnectionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
predictQAResults
default PredictQaResultsResponse predictQAResults(PredictQaResultsRequest predictQaResultsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Predicts existing visuals or generates new visuals to answer a given query.
This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for QuickSight with the scope value set to
quicksight:read. Before you use this action, make sure that you have configured the relevant QuickSight resource and permissions.We recommend enabling the
QSearchStatusAPI to unlock the full potential ofPredictQnA. WhenQSearchStatusis enabled, it first checks the specified dashboard for any existing visuals that match the question. If no matching visuals are found,PredictQnAuses generative Q&A to provide an answer. To update theQSearchStatus, see UpdateQuickSightQSearchConfiguration.- Parameters:
predictQaResultsRequest-- Returns:
- Result of the PredictQAResults operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
predictQAResults
default PredictQaResultsResponse predictQAResults(Consumer<PredictQaResultsRequest.Builder> predictQaResultsRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Predicts existing visuals or generates new visuals to answer a given query.
This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for QuickSight with the scope value set to
quicksight:read. Before you use this action, make sure that you have configured the relevant QuickSight resource and permissions.We recommend enabling the
QSearchStatusAPI to unlock the full potential ofPredictQnA. WhenQSearchStatusis enabled, it first checks the specified dashboard for any existing visuals that match the question. If no matching visuals are found,PredictQnAuses generative Q&A to provide an answer. To update theQSearchStatus, see UpdateQuickSightQSearchConfiguration.
This is a convenience which creates an instance of the
PredictQaResultsRequest.Builderavoiding the need to create one manually viaPredictQaResultsRequest.builder()- Parameters:
predictQaResultsRequest- AConsumerthat will call methods onPredictQaResultsRequest.Builderto create a request.- Returns:
- Result of the PredictQAResults operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
putDataSetRefreshProperties
default PutDataSetRefreshPropertiesResponse putDataSetRefreshProperties(PutDataSetRefreshPropertiesRequest putDataSetRefreshPropertiesRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, PreconditionNotMetException, ConflictException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates or updates the dataset refresh properties for the dataset.
- Parameters:
putDataSetRefreshPropertiesRequest-- Returns:
- Result of the PutDataSetRefreshProperties operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
putDataSetRefreshProperties
default PutDataSetRefreshPropertiesResponse putDataSetRefreshProperties(Consumer<PutDataSetRefreshPropertiesRequest.Builder> putDataSetRefreshPropertiesRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, PreconditionNotMetException, ConflictException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Creates or updates the dataset refresh properties for the dataset.
This is a convenience which creates an instance of the
PutDataSetRefreshPropertiesRequest.Builderavoiding the need to create one manually viaPutDataSetRefreshPropertiesRequest.builder()- Parameters:
putDataSetRefreshPropertiesRequest- AConsumerthat will call methods onPutDataSetRefreshPropertiesRequest.Builderto create a request.- Returns:
- Result of the PutDataSetRefreshProperties operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
registerUser
default RegisterUserResponse registerUser(RegisterUserRequest registerUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, ResourceExistsException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the QuickSight API, QuickSight generates a registration URL. The user accesses this registration URL to create their account. QuickSight doesn't send a registration email to users who are registered from the QuickSight API. If you want new users to receive a registration email, then add those users in the QuickSight console. For more information on registering a new user in the QuickSight console, see Inviting users to access QuickSight.
- Parameters:
registerUserRequest-- Returns:
- Result of the RegisterUser operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
registerUser
default RegisterUserResponse registerUser(Consumer<RegisterUserRequest.Builder> registerUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, ResourceExistsException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the QuickSight API, QuickSight generates a registration URL. The user accesses this registration URL to create their account. QuickSight doesn't send a registration email to users who are registered from the QuickSight API. If you want new users to receive a registration email, then add those users in the QuickSight console. For more information on registering a new user in the QuickSight console, see Inviting users to access QuickSight.
This is a convenience which creates an instance of the
RegisterUserRequest.Builderavoiding the need to create one manually viaRegisterUserRequest.builder()- Parameters:
registerUserRequest- AConsumerthat will call methods onRegisterUserRequest.Builderto create a request.- Returns:
- Result of the RegisterUser operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
restoreAnalysis
default RestoreAnalysisResponse restoreAnalysis(RestoreAnalysisRequest restoreAnalysisRequest) throws ThrottlingException, InvalidParameterValueException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, LimitExceededException, PreconditionNotMetException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Restores an analysis.
- Parameters:
restoreAnalysisRequest-- Returns:
- Result of the RestoreAnalysis operation returned by the service.
- Throws:
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 QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.LimitExceededException- A limit is exceeded.PreconditionNotMetException- One or more preconditions aren't met.InternalFailureException- An internal failure occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
restoreAnalysis
default RestoreAnalysisResponse restoreAnalysis(Consumer<RestoreAnalysisRequest.Builder> restoreAnalysisRequest) throws ThrottlingException, InvalidParameterValueException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, LimitExceededException, PreconditionNotMetException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Restores an analysis.
This is a convenience which creates an instance of the
RestoreAnalysisRequest.Builderavoiding the need to create one manually viaRestoreAnalysisRequest.builder()- Parameters:
restoreAnalysisRequest- AConsumerthat will call methods onRestoreAnalysisRequest.Builderto create a request.- Returns:
- Result of the RestoreAnalysis operation returned by the service.
- Throws:
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 QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.LimitExceededException- A limit is exceeded.PreconditionNotMetException- One or more preconditions aren't met.InternalFailureException- An internal failure occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
searchAnalyses
default SearchAnalysesResponse searchAnalyses(SearchAnalysesRequest searchAnalysesRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Searches for analyses that belong to the user specified in the filter.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
- Parameters:
searchAnalysesRequest-- Returns:
- Result of the SearchAnalyses operation returned by the service.
- Throws:
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 QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchAnalyses
default SearchAnalysesResponse searchAnalyses(Consumer<SearchAnalysesRequest.Builder> searchAnalysesRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Searches for analyses that belong to the user specified in the filter.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This is a convenience which creates an instance of the
SearchAnalysesRequest.Builderavoiding the need to create one manually viaSearchAnalysesRequest.builder()- Parameters:
searchAnalysesRequest- AConsumerthat will call methods onSearchAnalysesRequest.Builderto create a request.- Returns:
- Result of the SearchAnalyses operation returned by the service.
- Throws:
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 QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchAnalysesPaginator
default SearchAnalysesIterable searchAnalysesPaginator(SearchAnalysesRequest searchAnalysesRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
searchAnalyses(software.amazon.awssdk.services.quicksight.model.SearchAnalysesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.SearchAnalysesIterable responses = client.searchAnalysesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.SearchAnalysesIterable responses = client .searchAnalysesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.SearchAnalysesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.SearchAnalysesIterable responses = client.searchAnalysesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchAnalyses(software.amazon.awssdk.services.quicksight.model.SearchAnalysesRequest)operation.- Parameters:
searchAnalysesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchAnalysesPaginator
default SearchAnalysesIterable searchAnalysesPaginator(Consumer<SearchAnalysesRequest.Builder> searchAnalysesRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
searchAnalyses(software.amazon.awssdk.services.quicksight.model.SearchAnalysesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.SearchAnalysesIterable responses = client.searchAnalysesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.SearchAnalysesIterable responses = client .searchAnalysesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.SearchAnalysesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.SearchAnalysesIterable responses = client.searchAnalysesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchAnalyses(software.amazon.awssdk.services.quicksight.model.SearchAnalysesRequest)operation.
This is a convenience which creates an instance of the
SearchAnalysesRequest.Builderavoiding the need to create one manually viaSearchAnalysesRequest.builder()- Parameters:
searchAnalysesRequest- AConsumerthat will call methods onSearchAnalysesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchDashboards
default SearchDashboardsResponse searchDashboards(SearchDashboardsRequest searchDashboardsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Searches for dashboards that belong to a user.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
- Parameters:
searchDashboardsRequest-- Returns:
- Result of the SearchDashboards operation returned by the service.
- Throws:
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 QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchDashboards
default SearchDashboardsResponse searchDashboards(Consumer<SearchDashboardsRequest.Builder> searchDashboardsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Searches for dashboards that belong to a user.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This is a convenience which creates an instance of the
SearchDashboardsRequest.Builderavoiding the need to create one manually viaSearchDashboardsRequest.builder()- Parameters:
searchDashboardsRequest- AConsumerthat will call methods onSearchDashboardsRequest.Builderto create a request.- Returns:
- Result of the SearchDashboards operation returned by the service.
- Throws:
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 QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchDashboardsPaginator
default SearchDashboardsIterable searchDashboardsPaginator(SearchDashboardsRequest searchDashboardsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
searchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.SearchDashboardsIterable responses = client.searchDashboardsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsIterable responses = client .searchDashboardsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.SearchDashboardsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.SearchDashboardsIterable responses = client.searchDashboardsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest)operation.- Parameters:
searchDashboardsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchDashboardsPaginator
default SearchDashboardsIterable searchDashboardsPaginator(Consumer<SearchDashboardsRequest.Builder> searchDashboardsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
searchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.SearchDashboardsIterable responses = client.searchDashboardsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.SearchDashboardsIterable responses = client .searchDashboardsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.SearchDashboardsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.SearchDashboardsIterable responses = client.searchDashboardsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDashboards(software.amazon.awssdk.services.quicksight.model.SearchDashboardsRequest)operation.
This is a convenience which creates an instance of the
SearchDashboardsRequest.Builderavoiding the need to create one manually viaSearchDashboardsRequest.builder()- Parameters:
searchDashboardsRequest- AConsumerthat will call methods onSearchDashboardsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchDataSets
default SearchDataSetsResponse searchDataSets(SearchDataSetsRequest searchDataSetsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, AccessDeniedException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Use the
SearchDataSetsoperation to search for datasets that belong to an account.- Parameters:
searchDataSetsRequest-- Returns:
- Result of the SearchDataSets operation returned by the service.
- Throws:
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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchDataSets
default SearchDataSetsResponse searchDataSets(Consumer<SearchDataSetsRequest.Builder> searchDataSetsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, AccessDeniedException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Use the
SearchDataSetsoperation to search for datasets that belong to an account.
This is a convenience which creates an instance of the
SearchDataSetsRequest.Builderavoiding the need to create one manually viaSearchDataSetsRequest.builder()- Parameters:
searchDataSetsRequest- AConsumerthat will call methods onSearchDataSetsRequest.Builderto create a request.- Returns:
- Result of the SearchDataSets operation returned by the service.
- Throws:
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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchDataSetsPaginator
default SearchDataSetsIterable searchDataSetsPaginator(SearchDataSetsRequest searchDataSetsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, AccessDeniedException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
searchDataSets(software.amazon.awssdk.services.quicksight.model.SearchDataSetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.SearchDataSetsIterable responses = client.searchDataSetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.SearchDataSetsIterable responses = client .searchDataSetsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.SearchDataSetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.SearchDataSetsIterable responses = client.searchDataSetsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDataSets(software.amazon.awssdk.services.quicksight.model.SearchDataSetsRequest)operation.- Parameters:
searchDataSetsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchDataSetsPaginator
default SearchDataSetsIterable searchDataSetsPaginator(Consumer<SearchDataSetsRequest.Builder> searchDataSetsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, AccessDeniedException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
searchDataSets(software.amazon.awssdk.services.quicksight.model.SearchDataSetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.SearchDataSetsIterable responses = client.searchDataSetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.SearchDataSetsIterable responses = client .searchDataSetsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.SearchDataSetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.SearchDataSetsIterable responses = client.searchDataSetsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDataSets(software.amazon.awssdk.services.quicksight.model.SearchDataSetsRequest)operation.
This is a convenience which creates an instance of the
SearchDataSetsRequest.Builderavoiding the need to create one manually viaSearchDataSetsRequest.builder()- Parameters:
searchDataSetsRequest- AConsumerthat will call methods onSearchDataSetsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchDataSources
default SearchDataSourcesResponse searchDataSources(SearchDataSourcesRequest searchDataSourcesRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, AccessDeniedException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Use the
SearchDataSourcesoperation to search for data sources that belong to an account.- Parameters:
searchDataSourcesRequest-- Returns:
- Result of the SearchDataSources operation returned by the service.
- Throws:
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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchDataSources
default SearchDataSourcesResponse searchDataSources(Consumer<SearchDataSourcesRequest.Builder> searchDataSourcesRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, AccessDeniedException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Use the
SearchDataSourcesoperation to search for data sources that belong to an account.
This is a convenience which creates an instance of the
SearchDataSourcesRequest.Builderavoiding the need to create one manually viaSearchDataSourcesRequest.builder()- Parameters:
searchDataSourcesRequest- AConsumerthat will call methods onSearchDataSourcesRequest.Builderto create a request.- Returns:
- Result of the SearchDataSources operation returned by the service.
- Throws:
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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchDataSourcesPaginator
default SearchDataSourcesIterable searchDataSourcesPaginator(SearchDataSourcesRequest searchDataSourcesRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, AccessDeniedException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
searchDataSources(software.amazon.awssdk.services.quicksight.model.SearchDataSourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.SearchDataSourcesIterable responses = client.searchDataSourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.SearchDataSourcesIterable responses = client .searchDataSourcesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.SearchDataSourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.SearchDataSourcesIterable responses = client.searchDataSourcesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDataSources(software.amazon.awssdk.services.quicksight.model.SearchDataSourcesRequest)operation.- Parameters:
searchDataSourcesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchDataSourcesPaginator
default SearchDataSourcesIterable searchDataSourcesPaginator(Consumer<SearchDataSourcesRequest.Builder> searchDataSourcesRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, AccessDeniedException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
searchDataSources(software.amazon.awssdk.services.quicksight.model.SearchDataSourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.SearchDataSourcesIterable responses = client.searchDataSourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.SearchDataSourcesIterable responses = client .searchDataSourcesPaginator(request); for (software.amazon.awssdk.services.quicksight.model.SearchDataSourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.SearchDataSourcesIterable responses = client.searchDataSourcesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchDataSources(software.amazon.awssdk.services.quicksight.model.SearchDataSourcesRequest)operation.
This is a convenience which creates an instance of the
SearchDataSourcesRequest.Builderavoiding the need to create one manually viaSearchDataSourcesRequest.builder()- Parameters:
searchDataSourcesRequest- AConsumerthat will call methods onSearchDataSourcesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchFolders
default SearchFoldersResponse searchFolders(SearchFoldersRequest searchFoldersRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InvalidRequestException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Searches the subfolders in a folder.
- Parameters:
searchFoldersRequest-- Returns:
- Result of the SearchFolders operation returned by the service.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchFolders
default SearchFoldersResponse searchFolders(Consumer<SearchFoldersRequest.Builder> searchFoldersRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InvalidRequestException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Searches the subfolders in a folder.
This is a convenience which creates an instance of the
SearchFoldersRequest.Builderavoiding the need to create one manually viaSearchFoldersRequest.builder()- Parameters:
searchFoldersRequest- AConsumerthat will call methods onSearchFoldersRequest.Builderto create a request.- Returns:
- Result of the SearchFolders operation returned by the service.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchFoldersPaginator
default SearchFoldersIterable searchFoldersPaginator(SearchFoldersRequest searchFoldersRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InvalidRequestException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
searchFolders(software.amazon.awssdk.services.quicksight.model.SearchFoldersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.SearchFoldersIterable responses = client.searchFoldersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.SearchFoldersIterable responses = client .searchFoldersPaginator(request); for (software.amazon.awssdk.services.quicksight.model.SearchFoldersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.SearchFoldersIterable responses = client.searchFoldersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchFolders(software.amazon.awssdk.services.quicksight.model.SearchFoldersRequest)operation.- Parameters:
searchFoldersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchFoldersPaginator
default SearchFoldersIterable searchFoldersPaginator(Consumer<SearchFoldersRequest.Builder> searchFoldersRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, UnsupportedUserEditionException, InvalidRequestException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
searchFolders(software.amazon.awssdk.services.quicksight.model.SearchFoldersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.SearchFoldersIterable responses = client.searchFoldersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.SearchFoldersIterable responses = client .searchFoldersPaginator(request); for (software.amazon.awssdk.services.quicksight.model.SearchFoldersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.SearchFoldersIterable responses = client.searchFoldersPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchFolders(software.amazon.awssdk.services.quicksight.model.SearchFoldersRequest)operation.
This is a convenience which creates an instance of the
SearchFoldersRequest.Builderavoiding the need to create one manually viaSearchFoldersRequest.builder()- Parameters:
searchFoldersRequest- AConsumerthat will call methods onSearchFoldersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- TheNextTokenvalue 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchGroups
default SearchGroupsResponse searchGroups(SearchGroupsRequest searchGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Use the
SearchGroupsoperation to search groups in a specified QuickSight namespace using the supplied filters.- Parameters:
searchGroupsRequest-- Returns:
- Result of the SearchGroups operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchGroups
default SearchGroupsResponse searchGroups(Consumer<SearchGroupsRequest.Builder> searchGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Use the
SearchGroupsoperation to search groups in a specified QuickSight namespace using the supplied filters.
This is a convenience which creates an instance of the
SearchGroupsRequest.Builderavoiding the need to create one manually viaSearchGroupsRequest.builder()- Parameters:
searchGroupsRequest- AConsumerthat will call methods onSearchGroupsRequest.Builderto create a request.- Returns:
- Result of the SearchGroups operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchGroupsPaginator
default SearchGroupsIterable searchGroupsPaginator(SearchGroupsRequest searchGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
searchGroups(software.amazon.awssdk.services.quicksight.model.SearchGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.SearchGroupsIterable responses = client.searchGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.SearchGroupsIterable responses = client.searchGroupsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.SearchGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.SearchGroupsIterable responses = client.searchGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchGroups(software.amazon.awssdk.services.quicksight.model.SearchGroupsRequest)operation.- Parameters:
searchGroupsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchGroupsPaginator
default SearchGroupsIterable searchGroupsPaginator(Consumer<SearchGroupsRequest.Builder> searchGroupsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InvalidNextTokenException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
searchGroups(software.amazon.awssdk.services.quicksight.model.SearchGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.SearchGroupsIterable responses = client.searchGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.SearchGroupsIterable responses = client.searchGroupsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.SearchGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.SearchGroupsIterable responses = client.searchGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchGroups(software.amazon.awssdk.services.quicksight.model.SearchGroupsRequest)operation.
This is a convenience which creates an instance of the
SearchGroupsRequest.Builderavoiding the need to create one manually viaSearchGroupsRequest.builder()- Parameters:
searchGroupsRequest- AConsumerthat will call methods onSearchGroupsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchTopics
default SearchTopicsResponse searchTopics(SearchTopicsRequest searchTopicsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Searches for any Q topic that exists in an QuickSight account.
- Parameters:
searchTopicsRequest-- Returns:
- Result of the SearchTopics operation returned by the service.
- Throws:
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 QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchTopics
default SearchTopicsResponse searchTopics(Consumer<SearchTopicsRequest.Builder> searchTopicsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Searches for any Q topic that exists in an QuickSight account.
This is a convenience which creates an instance of the
SearchTopicsRequest.Builderavoiding the need to create one manually viaSearchTopicsRequest.builder()- Parameters:
searchTopicsRequest- AConsumerthat will call methods onSearchTopicsRequest.Builderto create a request.- Returns:
- Result of the SearchTopics operation returned by the service.
- Throws:
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 QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchTopicsPaginator
default SearchTopicsIterable searchTopicsPaginator(SearchTopicsRequest searchTopicsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
searchTopics(software.amazon.awssdk.services.quicksight.model.SearchTopicsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.SearchTopicsIterable responses = client.searchTopicsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.SearchTopicsIterable responses = client.searchTopicsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.SearchTopicsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.SearchTopicsIterable responses = client.searchTopicsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchTopics(software.amazon.awssdk.services.quicksight.model.SearchTopicsRequest)operation.- Parameters:
searchTopicsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
searchTopicsPaginator
default SearchTopicsIterable searchTopicsPaginator(Consumer<SearchTopicsRequest.Builder> searchTopicsRequest) throws ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, UnsupportedUserEditionException, InvalidNextTokenException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
This is a variant of
searchTopics(software.amazon.awssdk.services.quicksight.model.SearchTopicsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.quicksight.paginators.SearchTopicsIterable responses = client.searchTopicsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.quicksight.paginators.SearchTopicsIterable responses = client.searchTopicsPaginator(request); for (software.amazon.awssdk.services.quicksight.model.SearchTopicsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.quicksight.paginators.SearchTopicsIterable responses = client.searchTopicsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchTopics(software.amazon.awssdk.services.quicksight.model.SearchTopicsRequest)operation.
This is a convenience which creates an instance of the
SearchTopicsRequest.Builderavoiding the need to create one manually viaSearchTopicsRequest.builder()- Parameters:
searchTopicsRequest- AConsumerthat will call methods onSearchTopicsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.InvalidNextTokenException- TheNextTokenvalue 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.AwsServiceException- See Also:
- AWS API Documentation
-
startAssetBundleExportJob
default StartAssetBundleExportJobResponse startAssetBundleExportJob(StartAssetBundleExportJobRequest startAssetBundleExportJobRequest) throws UnsupportedUserEditionException, ThrottlingException, InvalidParameterValueException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, QuickSightException
Starts an Asset Bundle export job.
An Asset Bundle export job exports specified 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
DescribeAssetBundleExportJobAPI call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with aDescribeAssetBundleExportJobAPI call. Each QuickSight account can run up to 5 export jobs concurrently.The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
- Parameters:
startAssetBundleExportJobRequest-- Returns:
- Result of the StartAssetBundleExportJob operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
startAssetBundleExportJob
default StartAssetBundleExportJobResponse startAssetBundleExportJob(Consumer<StartAssetBundleExportJobRequest.Builder> startAssetBundleExportJobRequest) throws UnsupportedUserEditionException, ThrottlingException, InvalidParameterValueException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, QuickSightException
Starts an Asset Bundle export job.
An Asset Bundle export job exports specified 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
DescribeAssetBundleExportJobAPI call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with aDescribeAssetBundleExportJobAPI call. Each 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.Builderavoiding the need to create one manually viaStartAssetBundleExportJobRequest.builder()- Parameters:
startAssetBundleExportJobRequest- AConsumerthat will call methods onStartAssetBundleExportJobRequest.Builderto create a request.- Returns:
- Result of the StartAssetBundleExportJob operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
startAssetBundleImportJob
default StartAssetBundleImportJobResponse startAssetBundleImportJob(StartAssetBundleImportJobRequest startAssetBundleImportJobRequest) throws UnsupportedUserEditionException, ThrottlingException, InvalidParameterValueException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, QuickSightException
Starts an Asset Bundle import job.
An Asset Bundle import job imports specified QuickSight assets into an 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 QuickSight account. Each QuickSight account can run up to 5 import jobs concurrently.
The API caller must have the necessary
"create","describe", and"update"permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.- Parameters:
startAssetBundleImportJobRequest-- Returns:
- Result of the StartAssetBundleImportJob operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
startAssetBundleImportJob
default StartAssetBundleImportJobResponse startAssetBundleImportJob(Consumer<StartAssetBundleImportJobRequest.Builder> startAssetBundleImportJobRequest) throws UnsupportedUserEditionException, ThrottlingException, InvalidParameterValueException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, QuickSightException
Starts an Asset Bundle import job.
An Asset Bundle import job imports specified QuickSight assets into an 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 QuickSight account. Each 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.Builderavoiding the need to create one manually viaStartAssetBundleImportJobRequest.builder()- Parameters:
startAssetBundleImportJobRequest- AConsumerthat will call methods onStartAssetBundleImportJobRequest.Builderto create a request.- Returns:
- Result of the StartAssetBundleImportJob operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
startDashboardSnapshotJob
default StartDashboardSnapshotJobResponse startDashboardSnapshotJob(StartDashboardSnapshotJobRequest startDashboardSnapshotJobRequest) throws AccessDeniedException, InvalidParameterValueException, LimitExceededException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, UnsupportedPricingPlanException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.
-
1 Paginated PDF
-
1 Excel workbook that includes up to 5 table or pivot table visuals
-
5 CSVs from table or pivot table visuals
The status of a submitted job can be polled with the
DescribeDashboardSnapshotJobAPI. When you call theDescribeDashboardSnapshotJobAPI, check theJobStatusfield in the response. Once the job reaches aCOMPLETEDorFAILEDstatus, use theDescribeDashboardSnapshotJobResultAPI to obtain the URLs for the generated files. If the job fails, theDescribeDashboardSnapshotJobResultAPI returns detailed information about the error that occurred.StartDashboardSnapshotJob API throttling
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, QuickSight throttles the API calls to maintin an optimal experience and reliability for all QuickSight users.Common throttling scenarios
The following list provides information about the most commin throttling scenarios that can occur.
-
A large number of
SnapshotExportAPI jobs are running simultaneously on an Amazon Web Services account. When a newStartDashboardSnapshotJobis created and there are already 12 jobs with theRUNNINGstatus, the new job request fails and returns aLimitExceededExceptionerror. Wait for a current job to comlpete before you resubmit the new job. -
A large number of API requests are submitted on an Amazon Web Services account. When a user makes more than 10 API calls to the QuickSight API in one second, a
ThrottlingExceptionis returned.
If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account.
Best practices to handle throttling
If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the QuickSight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example
(12 minutes * 9 = 108 minutes). Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline.The time that it takes to process a job can be impacted by the following factors:
-
The dataset type (Direct Query or SPICE).
-
The size of the dataset.
-
The complexity of the calculated fields that are used in the dashboard.
-
The number of visuals that are on a sheet.
-
The types of visuals that are on the sheet.
-
The number of formats and snapshots that are requested in the job configuration.
-
The size of the generated snapshots.
- Parameters:
startDashboardSnapshotJobRequest-- Returns:
- Result of the StartDashboardSnapshotJob operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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 QuickSight. You can do this on the Manage QuickSight page.After capacity pricing is added, you can use the
GetDashboardEmbedUrlAPI operation with the--identity-type ANONYMOUSoption.InternalFailureException- An internal failure occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
startDashboardSnapshotJob
default StartDashboardSnapshotJobResponse startDashboardSnapshotJob(Consumer<StartDashboardSnapshotJobRequest.Builder> startDashboardSnapshotJobRequest) throws AccessDeniedException, InvalidParameterValueException, LimitExceededException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, UnsupportedPricingPlanException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.
-
1 Paginated PDF
-
1 Excel workbook that includes up to 5 table or pivot table visuals
-
5 CSVs from table or pivot table visuals
The status of a submitted job can be polled with the
DescribeDashboardSnapshotJobAPI. When you call theDescribeDashboardSnapshotJobAPI, check theJobStatusfield in the response. Once the job reaches aCOMPLETEDorFAILEDstatus, use theDescribeDashboardSnapshotJobResultAPI to obtain the URLs for the generated files. If the job fails, theDescribeDashboardSnapshotJobResultAPI returns detailed information about the error that occurred.StartDashboardSnapshotJob API throttling
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, QuickSight throttles the API calls to maintin an optimal experience and reliability for all QuickSight users.Common throttling scenarios
The following list provides information about the most commin throttling scenarios that can occur.
-
A large number of
SnapshotExportAPI jobs are running simultaneously on an Amazon Web Services account. When a newStartDashboardSnapshotJobis created and there are already 12 jobs with theRUNNINGstatus, the new job request fails and returns aLimitExceededExceptionerror. Wait for a current job to comlpete before you resubmit the new job. -
A large number of API requests are submitted on an Amazon Web Services account. When a user makes more than 10 API calls to the QuickSight API in one second, a
ThrottlingExceptionis returned.
If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account.
Best practices to handle throttling
If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the 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.Builderavoiding the need to create one manually viaStartDashboardSnapshotJobRequest.builder()- Parameters:
startDashboardSnapshotJobRequest- AConsumerthat will call methods onStartDashboardSnapshotJobRequest.Builderto create a request.- Returns:
- Result of the StartDashboardSnapshotJob operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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 QuickSight. You can do this on the Manage QuickSight page.After capacity pricing is added, you can use the
GetDashboardEmbedUrlAPI operation with the--identity-type ANONYMOUSoption.InternalFailureException- An internal failure occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
startDashboardSnapshotJobSchedule
default StartDashboardSnapshotJobScheduleResponse startDashboardSnapshotJobSchedule(StartDashboardSnapshotJobScheduleRequest startDashboardSnapshotJobScheduleRequest) throws AccessDeniedException, InvalidParameterValueException, LimitExceededException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.
Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a
202HTTP status code.For more information, see Scheduling and sending QuickSight reports by email and Configuring email report settings for a QuickSight dashboard in the Amazon QuickSight User Guide.
- Parameters:
startDashboardSnapshotJobScheduleRequest-- Returns:
- Result of the StartDashboardSnapshotJobSchedule operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
startDashboardSnapshotJobSchedule
default StartDashboardSnapshotJobScheduleResponse startDashboardSnapshotJobSchedule(Consumer<StartDashboardSnapshotJobScheduleRequest.Builder> startDashboardSnapshotJobScheduleRequest) throws AccessDeniedException, InvalidParameterValueException, LimitExceededException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.
Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a
202HTTP status code.For more information, see Scheduling and sending QuickSight reports by email and Configuring email report settings for a QuickSight dashboard in the Amazon QuickSight User Guide.
This is a convenience which creates an instance of the
StartDashboardSnapshotJobScheduleRequest.Builderavoiding the need to create one manually viaStartDashboardSnapshotJobScheduleRequest.builder()- Parameters:
startDashboardSnapshotJobScheduleRequest- AConsumerthat will call methods onStartDashboardSnapshotJobScheduleRequest.Builderto create a request.- Returns:
- Result of the StartDashboardSnapshotJobSchedule operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.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 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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws LimitExceededException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Assigns one or more tags (key-value pairs) to the specified 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
TagResourceoperation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.You can associate as many as 50 tags with a resource. QuickSight supports tagging on data set, data source, dashboard, template, topic, and user.
Tagging for 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 QuickSight. You can't tag other resources that QuickSight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units.
-
QuickSight doesn't currently support the tag editor for Resource Groups.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws LimitExceededException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Assigns one or more tags (key-value pairs) to the specified 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
TagResourceoperation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.You can associate as many as 50 tags with a resource. QuickSight supports tagging on data set, data source, dashboard, template, topic, and user.
Tagging for 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 QuickSight. You can't tag other resources that QuickSight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units.
-
QuickSight doesn't currently support the tag editor for Resource Groups.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Removes a tag or tags from a resource.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Removes a tag or tags from a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAccountCustomPermission
default UpdateAccountCustomPermissionResponse updateAccountCustomPermission(UpdateAccountCustomPermissionRequest updateAccountCustomPermissionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Applies a custom permissions profile to an account.
- Parameters:
updateAccountCustomPermissionRequest-- Returns:
- Result of the UpdateAccountCustomPermission operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAccountCustomPermission
default UpdateAccountCustomPermissionResponse updateAccountCustomPermission(Consumer<UpdateAccountCustomPermissionRequest.Builder> updateAccountCustomPermissionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Applies a custom permissions profile to an account.
This is a convenience which creates an instance of the
UpdateAccountCustomPermissionRequest.Builderavoiding the need to create one manually viaUpdateAccountCustomPermissionRequest.builder()- Parameters:
updateAccountCustomPermissionRequest- AConsumerthat will call methods onUpdateAccountCustomPermissionRequest.Builderto create a request.- Returns:
- Result of the UpdateAccountCustomPermission operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAccountCustomization
default UpdateAccountCustomizationResponse updateAccountCustomization(UpdateAccountCustomizationRequest updateAccountCustomizationRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.
You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a 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
DescribeAccountCustomizationAPI operation.- Parameters:
updateAccountCustomizationRequest-- Returns:
- Result of the UpdateAccountCustomization operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAccountCustomization
default UpdateAccountCustomizationResponse updateAccountCustomization(Consumer<UpdateAccountCustomizationRequest.Builder> updateAccountCustomizationRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.
You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a 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
DescribeAccountCustomizationAPI operation.
This is a convenience which creates an instance of the
UpdateAccountCustomizationRequest.Builderavoiding the need to create one manually viaUpdateAccountCustomizationRequest.builder()- Parameters:
updateAccountCustomizationRequest- AConsumerthat will call methods onUpdateAccountCustomizationRequest.Builderto create a request.- Returns:
- Result of the UpdateAccountCustomization operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAccountSettings
default UpdateAccountSettingsResponse updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Updates the Amazon QuickSight settings in your Amazon Web Services account.
- Parameters:
updateAccountSettingsRequest-- Returns:
- Result of the UpdateAccountSettings operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAccountSettings
default UpdateAccountSettingsResponse updateAccountSettings(Consumer<UpdateAccountSettingsRequest.Builder> updateAccountSettingsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Updates the Amazon QuickSight settings in your Amazon Web Services account.
This is a convenience which creates an instance of the
UpdateAccountSettingsRequest.Builderavoiding the need to create one manually viaUpdateAccountSettingsRequest.builder()- Parameters:
updateAccountSettingsRequest- AConsumerthat will call methods onUpdateAccountSettingsRequest.Builderto create a request.- Returns:
- Result of the UpdateAccountSettings operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAnalysis
default UpdateAnalysisResponse updateAnalysis(UpdateAnalysisRequest updateAnalysisRequest) throws ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, ResourceExistsException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates an analysis in Amazon QuickSight
- Parameters:
updateAnalysisRequest-- Returns:
- Result of the UpdateAnalysis operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAnalysis
default UpdateAnalysisResponse updateAnalysis(Consumer<UpdateAnalysisRequest.Builder> updateAnalysisRequest) throws ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, ResourceExistsException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates an analysis in Amazon QuickSight
This is a convenience which creates an instance of the
UpdateAnalysisRequest.Builderavoiding the need to create one manually viaUpdateAnalysisRequest.builder()- Parameters:
updateAnalysisRequest- AConsumerthat will call methods onUpdateAnalysisRequest.Builderto create a request.- Returns:
- Result of the UpdateAnalysis operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAnalysisPermissions
default UpdateAnalysisPermissionsResponse updateAnalysisPermissions(UpdateAnalysisPermissionsRequest updateAnalysisPermissionsRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, UnsupportedUserEditionException, ConflictException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the read and write permissions for an analysis.
- Parameters:
updateAnalysisPermissionsRequest-- Returns:
- Result of the UpdateAnalysisPermissions operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAnalysisPermissions
default UpdateAnalysisPermissionsResponse updateAnalysisPermissions(Consumer<UpdateAnalysisPermissionsRequest.Builder> updateAnalysisPermissionsRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, UnsupportedUserEditionException, ConflictException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the read and write permissions for an analysis.
This is a convenience which creates an instance of the
UpdateAnalysisPermissionsRequest.Builderavoiding the need to create one manually viaUpdateAnalysisPermissionsRequest.builder()- Parameters:
updateAnalysisPermissionsRequest- AConsumerthat will call methods onUpdateAnalysisPermissionsRequest.Builderto create a request.- Returns:
- Result of the UpdateAnalysisPermissions operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateApplicationWithTokenExchangeGrant
default UpdateApplicationWithTokenExchangeGrantResponse updateApplicationWithTokenExchangeGrant(UpdateApplicationWithTokenExchangeGrantRequest updateApplicationWithTokenExchangeGrantRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidRequestException, ResourceNotFoundException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates an QuickSight application with a token exchange grant. This operation only supports QuickSight applications that are registered with IAM Identity Center.
- Parameters:
updateApplicationWithTokenExchangeGrantRequest-- Returns:
- Result of the UpdateApplicationWithTokenExchangeGrant operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.InvalidRequestException- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.ResourceNotFoundException- One or more resources can't be found.LimitExceededException- A limit is exceeded.InternalFailureException- An internal failure occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateApplicationWithTokenExchangeGrant
default UpdateApplicationWithTokenExchangeGrantResponse updateApplicationWithTokenExchangeGrant(Consumer<UpdateApplicationWithTokenExchangeGrantRequest.Builder> updateApplicationWithTokenExchangeGrantRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InvalidRequestException, ResourceNotFoundException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates an QuickSight application with a token exchange grant. This operation only supports QuickSight applications that are registered with IAM Identity Center.
This is a convenience which creates an instance of the
UpdateApplicationWithTokenExchangeGrantRequest.Builderavoiding the need to create one manually viaUpdateApplicationWithTokenExchangeGrantRequest.builder()- Parameters:
updateApplicationWithTokenExchangeGrantRequest- AConsumerthat will call methods onUpdateApplicationWithTokenExchangeGrantRequest.Builderto create a request.- Returns:
- Result of the UpdateApplicationWithTokenExchangeGrant operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.InvalidRequestException- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.ResourceNotFoundException- One or more resources can't be found.LimitExceededException- A limit is exceeded.InternalFailureException- An internal failure occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateBrand
default UpdateBrandResponse updateBrand(UpdateBrandRequest updateBrandRequest) throws ThrottlingException, InvalidRequestException, ResourceNotFoundException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, QuickSightException
Updates a brand.
- Parameters:
updateBrandRequest-- Returns:
- Result of the UpdateBrand operation returned by the service.
- Throws:
ThrottlingException- Access is throttled.InvalidRequestException- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.ResourceNotFoundException- One or more resources can't be found.ConflictException- Updating or deleting a resource can cause an inconsistent state.AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.InternalServerException- An internal service exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateBrand
default UpdateBrandResponse updateBrand(Consumer<UpdateBrandRequest.Builder> updateBrandRequest) throws ThrottlingException, InvalidRequestException, ResourceNotFoundException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, QuickSightException
Updates a brand.
This is a convenience which creates an instance of the
UpdateBrandRequest.Builderavoiding the need to create one manually viaUpdateBrandRequest.builder()- Parameters:
updateBrandRequest- AConsumerthat will call methods onUpdateBrandRequest.Builderto create a request.- Returns:
- Result of the UpdateBrand operation returned by the service.
- Throws:
ThrottlingException- Access is throttled.InvalidRequestException- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.ResourceNotFoundException- One or more resources can't be found.ConflictException- Updating or deleting a resource can cause an inconsistent state.AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.InternalServerException- An internal service exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateBrandAssignment
default UpdateBrandAssignmentResponse updateBrandAssignment(UpdateBrandAssignmentRequest updateBrandAssignmentRequest) throws ThrottlingException, InvalidRequestException, ResourceNotFoundException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, QuickSightException
Updates a brand assignment.
- Parameters:
updateBrandAssignmentRequest-- Returns:
- Result of the UpdateBrandAssignment operation returned by the service.
- Throws:
ThrottlingException- Access is throttled.InvalidRequestException- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.ResourceNotFoundException- One or more resources can't be found.ConflictException- Updating or deleting a resource can cause an inconsistent state.AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.InternalServerException- An internal service exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateBrandAssignment
default UpdateBrandAssignmentResponse updateBrandAssignment(Consumer<UpdateBrandAssignmentRequest.Builder> updateBrandAssignmentRequest) throws ThrottlingException, InvalidRequestException, ResourceNotFoundException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, QuickSightException
Updates a brand assignment.
This is a convenience which creates an instance of the
UpdateBrandAssignmentRequest.Builderavoiding the need to create one manually viaUpdateBrandAssignmentRequest.builder()- Parameters:
updateBrandAssignmentRequest- AConsumerthat will call methods onUpdateBrandAssignmentRequest.Builderto create a request.- Returns:
- Result of the UpdateBrandAssignment operation returned by the service.
- Throws:
ThrottlingException- Access is throttled.InvalidRequestException- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.ResourceNotFoundException- One or more resources can't be found.ConflictException- Updating or deleting a resource can cause an inconsistent state.AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.InternalServerException- An internal service exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateBrandPublishedVersion
default UpdateBrandPublishedVersionResponse updateBrandPublishedVersion(UpdateBrandPublishedVersionRequest updateBrandPublishedVersionRequest) throws ThrottlingException, InvalidRequestException, ResourceNotFoundException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, QuickSightException
Updates the published version of a brand.
- Parameters:
updateBrandPublishedVersionRequest-- Returns:
- Result of the UpdateBrandPublishedVersion operation returned by the service.
- Throws:
ThrottlingException- Access is throttled.InvalidRequestException- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.ResourceNotFoundException- One or more resources can't be found.ConflictException- Updating or deleting a resource can cause an inconsistent state.AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.InternalServerException- An internal service exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateBrandPublishedVersion
default UpdateBrandPublishedVersionResponse updateBrandPublishedVersion(Consumer<UpdateBrandPublishedVersionRequest.Builder> updateBrandPublishedVersionRequest) throws ThrottlingException, InvalidRequestException, ResourceNotFoundException, ConflictException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, QuickSightException
Updates the published version of a brand.
This is a convenience which creates an instance of the
UpdateBrandPublishedVersionRequest.Builderavoiding the need to create one manually viaUpdateBrandPublishedVersionRequest.builder()- Parameters:
updateBrandPublishedVersionRequest- AConsumerthat will call methods onUpdateBrandPublishedVersionRequest.Builderto create a request.- Returns:
- Result of the UpdateBrandPublishedVersion operation returned by the service.
- Throws:
ThrottlingException- Access is throttled.InvalidRequestException- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.ResourceNotFoundException- One or more resources can't be found.ConflictException- Updating or deleting a resource can cause an inconsistent state.AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.InternalServerException- An internal service exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateCustomPermissions
default UpdateCustomPermissionsResponse updateCustomPermissions(UpdateCustomPermissionsRequest updateCustomPermissionsRequest) throws ConflictException, AccessDeniedException, ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Updates a custom permissions profile.
- Parameters:
updateCustomPermissionsRequest-- Returns:
- Result of the UpdateCustomPermissions operation returned by the service.
- Throws:
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.ResourceNotFoundException- One or more resources can't be found.InvalidParameterValueException- One or more parameters has a value that isn't valid.ThrottlingException- Access is throttled.PreconditionNotMetException- One or more preconditions aren't met.InternalFailureException- An internal failure occurred.ResourceUnavailableException- This resource is currently unavailable.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateCustomPermissions
default UpdateCustomPermissionsResponse updateCustomPermissions(Consumer<UpdateCustomPermissionsRequest.Builder> updateCustomPermissionsRequest) throws ConflictException, AccessDeniedException, ResourceNotFoundException, InvalidParameterValueException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Updates a custom permissions profile.
This is a convenience which creates an instance of the
UpdateCustomPermissionsRequest.Builderavoiding the need to create one manually viaUpdateCustomPermissionsRequest.builder()- Parameters:
updateCustomPermissionsRequest- AConsumerthat will call methods onUpdateCustomPermissionsRequest.Builderto create a request.- Returns:
- Result of the UpdateCustomPermissions operation returned by the service.
- Throws:
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.ResourceNotFoundException- One or more resources can't be found.InvalidParameterValueException- One or more parameters has a value that isn't valid.ThrottlingException- Access is throttled.PreconditionNotMetException- One or more preconditions aren't met.InternalFailureException- An internal failure occurred.ResourceUnavailableException- This resource is currently unavailable.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateDashboard
default UpdateDashboardResponse updateDashboard(UpdateDashboardRequest updateDashboardRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, ConflictException, LimitExceededException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a dashboard in an Amazon Web Services account.
Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the
UpdateDashboardPublishedVersionAPI operation.- Parameters:
updateDashboardRequest-- Returns:
- Result of the UpdateDashboard operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDashboard
default UpdateDashboardResponse updateDashboard(Consumer<UpdateDashboardRequest.Builder> updateDashboardRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, ConflictException, LimitExceededException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a dashboard in an Amazon Web Services account.
Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the
UpdateDashboardPublishedVersionAPI operation.
This is a convenience which creates an instance of the
UpdateDashboardRequest.Builderavoiding the need to create one manually viaUpdateDashboardRequest.builder()- Parameters:
updateDashboardRequest- AConsumerthat will call methods onUpdateDashboardRequest.Builderto create a request.- Returns:
- Result of the UpdateDashboard operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDashboardLinks
default UpdateDashboardLinksResponse updateDashboardLinks(UpdateDashboardLinksRequest updateDashboardLinksRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, ConflictException, AccessDeniedException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the linked analyses on a dashboard.
- Parameters:
updateDashboardLinksRequest-- Returns:
- Result of the UpdateDashboardLinks operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDashboardLinks
default UpdateDashboardLinksResponse updateDashboardLinks(Consumer<UpdateDashboardLinksRequest.Builder> updateDashboardLinksRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, ConflictException, AccessDeniedException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the linked analyses on a dashboard.
This is a convenience which creates an instance of the
UpdateDashboardLinksRequest.Builderavoiding the need to create one manually viaUpdateDashboardLinksRequest.builder()- Parameters:
updateDashboardLinksRequest- AConsumerthat will call methods onUpdateDashboardLinksRequest.Builderto create a request.- Returns:
- Result of the UpdateDashboardLinks operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDashboardPermissions
default UpdateDashboardPermissionsResponse updateDashboardPermissions(UpdateDashboardPermissionsRequest updateDashboardPermissionsRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, UnsupportedUserEditionException, ConflictException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates read and write permissions on a dashboard.
- Parameters:
updateDashboardPermissionsRequest-- Returns:
- Result of the UpdateDashboardPermissions operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDashboardPermissions
default UpdateDashboardPermissionsResponse updateDashboardPermissions(Consumer<UpdateDashboardPermissionsRequest.Builder> updateDashboardPermissionsRequest) throws ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, UnsupportedUserEditionException, ConflictException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates read and write permissions on a dashboard.
This is a convenience which creates an instance of the
UpdateDashboardPermissionsRequest.Builderavoiding the need to create one manually viaUpdateDashboardPermissionsRequest.builder()- Parameters:
updateDashboardPermissionsRequest- AConsumerthat will call methods onUpdateDashboardPermissionsRequest.Builderto create a request.- Returns:
- Result of the UpdateDashboardPermissions operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDashboardPublishedVersion
default UpdateDashboardPublishedVersionResponse updateDashboardPublishedVersion(UpdateDashboardPublishedVersionRequest updateDashboardPublishedVersionRequest) throws InvalidParameterValueException, ThrottlingException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the published version of a dashboard.
- Parameters:
updateDashboardPublishedVersionRequest-- Returns:
- Result of the UpdateDashboardPublishedVersion operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDashboardPublishedVersion
default UpdateDashboardPublishedVersionResponse updateDashboardPublishedVersion(Consumer<UpdateDashboardPublishedVersionRequest.Builder> updateDashboardPublishedVersionRequest) throws InvalidParameterValueException, ThrottlingException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the published version of a dashboard.
This is a convenience which creates an instance of the
UpdateDashboardPublishedVersionRequest.Builderavoiding the need to create one manually viaUpdateDashboardPublishedVersionRequest.builder()- Parameters:
updateDashboardPublishedVersionRequest- AConsumerthat will call methods onUpdateDashboardPublishedVersionRequest.Builderto create a request.- Returns:
- Result of the UpdateDashboardPublishedVersion operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDashboardsQAConfiguration
default UpdateDashboardsQaConfigurationResponse updateDashboardsQAConfiguration(UpdateDashboardsQaConfigurationRequest updateDashboardsQaConfigurationRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a Dashboard QA configuration.
- Parameters:
updateDashboardsQaConfigurationRequest-- Returns:
- Result of the UpdateDashboardsQAConfiguration operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDashboardsQAConfiguration
default UpdateDashboardsQaConfigurationResponse updateDashboardsQAConfiguration(Consumer<UpdateDashboardsQaConfigurationRequest.Builder> updateDashboardsQaConfigurationRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a Dashboard QA configuration.
This is a convenience which creates an instance of the
UpdateDashboardsQaConfigurationRequest.Builderavoiding the need to create one manually viaUpdateDashboardsQaConfigurationRequest.builder()- Parameters:
updateDashboardsQaConfigurationRequest- AConsumerthat will call methods onUpdateDashboardsQaConfigurationRequest.Builderto create a request.- Returns:
- Result of the UpdateDashboardsQAConfiguration operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDataSet
default UpdateDataSetResponse updateDataSet(UpdateDataSetRequest updateDataSetRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.
- Parameters:
updateDataSetRequest-- Returns:
- Result of the UpdateDataSet operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDataSet
default UpdateDataSetResponse updateDataSet(Consumer<UpdateDataSetRequest.Builder> updateDataSetRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ThrottlingException, ResourceNotFoundException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.
This is a convenience which creates an instance of the
UpdateDataSetRequest.Builderavoiding the need to create one manually viaUpdateDataSetRequest.builder()- Parameters:
updateDataSetRequest- AConsumerthat will call methods onUpdateDataSetRequest.Builderto create a request.- Returns:
- Result of the UpdateDataSet operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDataSetPermissions
default UpdateDataSetPermissionsResponse updateDataSetPermissions(UpdateDataSetPermissionsRequest updateDataSetPermissionsRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the permissions on a dataset.
The permissions resource is
arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.- Parameters:
updateDataSetPermissionsRequest-- Returns:
- Result of the UpdateDataSetPermissions operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDataSetPermissions
default UpdateDataSetPermissionsResponse updateDataSetPermissions(Consumer<UpdateDataSetPermissionsRequest.Builder> updateDataSetPermissionsRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the permissions on a dataset.
The permissions resource is
arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
This is a convenience which creates an instance of the
UpdateDataSetPermissionsRequest.Builderavoiding the need to create one manually viaUpdateDataSetPermissionsRequest.builder()- Parameters:
updateDataSetPermissionsRequest- AConsumerthat will call methods onUpdateDataSetPermissionsRequest.Builderto create a request.- Returns:
- Result of the UpdateDataSetPermissions operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDataSource
default UpdateDataSourceResponse updateDataSource(UpdateDataSourceRequest updateDataSourceRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, CustomerManagedKeyUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a data source.
- Parameters:
updateDataSourceRequest-- Returns:
- Result of the UpdateDataSource operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.CustomerManagedKeyUnavailableException- The customer managed key that is registered to your QuickSight account is unavailable.InternalFailureException- An internal failure occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateDataSource
default UpdateDataSourceResponse updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, CustomerManagedKeyUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a data source.
This is a convenience which creates an instance of the
UpdateDataSourceRequest.Builderavoiding the need to create one manually viaUpdateDataSourceRequest.builder()- Parameters:
updateDataSourceRequest- AConsumerthat will call methods onUpdateDataSourceRequest.Builderto create a request.- Returns:
- Result of the UpdateDataSource operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.CustomerManagedKeyUnavailableException- The customer managed key that is registered to your QuickSight account is unavailable.InternalFailureException- An internal failure occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateDataSourcePermissions
default UpdateDataSourcePermissionsResponse updateDataSourcePermissions(UpdateDataSourcePermissionsRequest updateDataSourcePermissionsRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the permissions to a data source.
- Parameters:
updateDataSourcePermissionsRequest-- Returns:
- Result of the UpdateDataSourcePermissions operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDataSourcePermissions
default UpdateDataSourcePermissionsResponse updateDataSourcePermissions(Consumer<UpdateDataSourcePermissionsRequest.Builder> updateDataSourcePermissionsRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the permissions to a data source.
This is a convenience which creates an instance of the
UpdateDataSourcePermissionsRequest.Builderavoiding the need to create one manually viaUpdateDataSourcePermissionsRequest.builder()- Parameters:
updateDataSourcePermissionsRequest- AConsumerthat will call methods onUpdateDataSourcePermissionsRequest.Builderto create a request.- Returns:
- Result of the UpdateDataSourcePermissions operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDefaultQBusinessApplication
default UpdateDefaultQBusinessApplicationResponse updateDefaultQBusinessApplication(UpdateDefaultQBusinessApplicationRequest updateDefaultQBusinessApplicationRequest) throws AccessDeniedException, ConflictException, ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a Amazon Q Business application that is linked to a QuickSight account.
- Parameters:
updateDefaultQBusinessApplicationRequest-- Returns:
- Result of the UpdateDefaultQBusinessApplication operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.ThrottlingException- Access is throttled.ResourceNotFoundException- One or more resources can't be found.InvalidParameterValueException- One or more parameters has a value that isn't valid.InternalFailureException- An internal failure occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateDefaultQBusinessApplication
default UpdateDefaultQBusinessApplicationResponse updateDefaultQBusinessApplication(Consumer<UpdateDefaultQBusinessApplicationRequest.Builder> updateDefaultQBusinessApplicationRequest) throws AccessDeniedException, ConflictException, ThrottlingException, ResourceNotFoundException, InvalidParameterValueException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a Amazon Q Business application that is linked to a QuickSight account.
This is a convenience which creates an instance of the
UpdateDefaultQBusinessApplicationRequest.Builderavoiding the need to create one manually viaUpdateDefaultQBusinessApplicationRequest.builder()- Parameters:
updateDefaultQBusinessApplicationRequest- AConsumerthat will call methods onUpdateDefaultQBusinessApplicationRequest.Builderto create a request.- Returns:
- Result of the UpdateDefaultQBusinessApplication operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.ThrottlingException- Access is throttled.ResourceNotFoundException- One or more resources can't be found.InvalidParameterValueException- One or more parameters has a value that isn't valid.InternalFailureException- An internal failure occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateFolder
default UpdateFolderResponse updateFolder(UpdateFolderRequest updateFolderRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceExistsException, ResourceNotFoundException, ConflictException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the name of a folder.
- Parameters:
updateFolderRequest-- Returns:
- Result of the UpdateFolder operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateFolder
default UpdateFolderResponse updateFolder(Consumer<UpdateFolderRequest.Builder> updateFolderRequest) throws InvalidParameterValueException, AccessDeniedException, ResourceExistsException, ResourceNotFoundException, ConflictException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the name of a folder.
This is a convenience which creates an instance of the
UpdateFolderRequest.Builderavoiding the need to create one manually viaUpdateFolderRequest.builder()- Parameters:
updateFolderRequest- AConsumerthat will call methods onUpdateFolderRequest.Builderto create a request.- Returns:
- Result of the UpdateFolder operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateFolderPermissions
default UpdateFolderPermissionsResponse updateFolderPermissions(UpdateFolderPermissionsRequest updateFolderPermissionsRequest) throws InvalidParameterValueException, AccessDeniedException, LimitExceededException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates permissions of a folder.
- Parameters:
updateFolderPermissionsRequest-- Returns:
- Result of the UpdateFolderPermissions operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateFolderPermissions
default UpdateFolderPermissionsResponse updateFolderPermissions(Consumer<UpdateFolderPermissionsRequest.Builder> updateFolderPermissionsRequest) throws InvalidParameterValueException, AccessDeniedException, LimitExceededException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates permissions of a folder.
This is a convenience which creates an instance of the
UpdateFolderPermissionsRequest.Builderavoiding the need to create one manually viaUpdateFolderPermissionsRequest.builder()- Parameters:
updateFolderPermissionsRequest- AConsumerthat will call methods onUpdateFolderPermissionsRequest.Builderto create a request.- Returns:
- Result of the UpdateFolderPermissions operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateGroup
default UpdateGroupResponse updateGroup(UpdateGroupRequest updateGroupRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Changes a group description.
- Parameters:
updateGroupRequest-- Returns:
- Result of the UpdateGroup operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateGroup
default UpdateGroupResponse updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Changes a group description.
This is a convenience which creates an instance of the
UpdateGroupRequest.Builderavoiding the need to create one manually viaUpdateGroupRequest.builder()- Parameters:
updateGroupRequest- AConsumerthat will call methods onUpdateGroupRequest.Builderto create a request.- Returns:
- Result of the UpdateGroup operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateIAMPolicyAssignment
default UpdateIamPolicyAssignmentResponse updateIAMPolicyAssignment(UpdateIamPolicyAssignmentRequest updateIamPolicyAssignmentRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConcurrentUpdatingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in
Identities.- Parameters:
updateIamPolicyAssignmentRequest-- Returns:
- Result of the UpdateIAMPolicyAssignment operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateIAMPolicyAssignment
default UpdateIamPolicyAssignmentResponse updateIAMPolicyAssignment(Consumer<UpdateIamPolicyAssignmentRequest.Builder> updateIamPolicyAssignmentRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConcurrentUpdatingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in
Identities.
This is a convenience which creates an instance of the
UpdateIamPolicyAssignmentRequest.Builderavoiding the need to create one manually viaUpdateIamPolicyAssignmentRequest.builder()- Parameters:
updateIamPolicyAssignmentRequest- AConsumerthat will call methods onUpdateIamPolicyAssignmentRequest.Builderto create a request.- Returns:
- Result of the UpdateIAMPolicyAssignment operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateIdentityPropagationConfig
default UpdateIdentityPropagationConfigResponse updateIdentityPropagationConfig(UpdateIdentityPropagationConfigRequest updateIdentityPropagationConfigRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Adds or updates services and authorized targets to configure what the QuickSight IAM Identity Center application can access.
This operation is only supported for QuickSight accounts using IAM Identity Center
- Parameters:
updateIdentityPropagationConfigRequest-- Returns:
- Result of the UpdateIdentityPropagationConfig operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateIdentityPropagationConfig
default UpdateIdentityPropagationConfigResponse updateIdentityPropagationConfig(Consumer<UpdateIdentityPropagationConfigRequest.Builder> updateIdentityPropagationConfigRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Adds or updates services and authorized targets to configure what the QuickSight IAM Identity Center application can access.
This operation is only supported for QuickSight accounts using IAM Identity Center
This is a convenience which creates an instance of the
UpdateIdentityPropagationConfigRequest.Builderavoiding the need to create one manually viaUpdateIdentityPropagationConfigRequest.builder()- Parameters:
updateIdentityPropagationConfigRequest- AConsumerthat will call methods onUpdateIdentityPropagationConfigRequest.Builderto create a request.- Returns:
- Result of the UpdateIdentityPropagationConfig operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateIpRestriction
default UpdateIpRestrictionResponse updateIpRestriction(UpdateIpRestrictionRequest updateIpRestrictionRequest) throws LimitExceededException, AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the
IpRestrictionRule,VpcIdRestrictionRule, orVpcEndpointIdRestrictionRule. To use this operation, you must provide the entire map of rules. You can use theDescribeIpRestrictionoperation to get the current rule map.- Parameters:
updateIpRestrictionRequest-- Returns:
- Result of the UpdateIpRestriction operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateIpRestriction
default UpdateIpRestrictionResponse updateIpRestriction(Consumer<UpdateIpRestrictionRequest.Builder> updateIpRestrictionRequest) throws LimitExceededException, AccessDeniedException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the
IpRestrictionRule,VpcIdRestrictionRule, orVpcEndpointIdRestrictionRule. To use this operation, you must provide the entire map of rules. You can use theDescribeIpRestrictionoperation to get the current rule map.
This is a convenience which creates an instance of the
UpdateIpRestrictionRequest.Builderavoiding the need to create one manually viaUpdateIpRestrictionRequest.builder()- Parameters:
updateIpRestrictionRequest- AConsumerthat will call methods onUpdateIpRestrictionRequest.Builderto create a request.- Returns:
- Result of the UpdateIpRestriction operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateKeyRegistration
default UpdateKeyRegistrationResponse updateKeyRegistration(UpdateKeyRegistrationRequest updateKeyRegistrationRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a customer managed key in a QuickSight account.
- Parameters:
updateKeyRegistrationRequest-- Returns:
- Result of the UpdateKeyRegistration operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateKeyRegistration
default UpdateKeyRegistrationResponse updateKeyRegistration(Consumer<UpdateKeyRegistrationRequest.Builder> updateKeyRegistrationRequest) throws AccessDeniedException, InvalidParameterValueException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a customer managed key in a QuickSight account.
This is a convenience which creates an instance of the
UpdateKeyRegistrationRequest.Builderavoiding the need to create one manually viaUpdateKeyRegistrationRequest.builder()- Parameters:
updateKeyRegistrationRequest- AConsumerthat will call methods onUpdateKeyRegistrationRequest.Builderto create a request.- Returns:
- Result of the UpdateKeyRegistration operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updatePublicSharingSettings
default UpdatePublicSharingSettingsResponse updatePublicSharingSettings(UpdatePublicSharingSettingsRequest updatePublicSharingSettingsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedPricingPlanException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Use the
UpdatePublicSharingSettingsoperation to turn on or turn off the public sharing settings of an QuickSight dashboard.To use this operation, turn on session capacity pricing for your 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 QuickSight, see Using QuickSight with IAM in the QuickSight User Guide.
- Parameters:
updatePublicSharingSettingsRequest-- Returns:
- Result of the UpdatePublicSharingSettings operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 QuickSight. You can do this on the Manage QuickSight page.After capacity pricing is added, you can use the
GetDashboardEmbedUrlAPI operation with the--identity-type ANONYMOUSoption.InternalFailureException- An internal failure occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updatePublicSharingSettings
default UpdatePublicSharingSettingsResponse updatePublicSharingSettings(Consumer<UpdatePublicSharingSettingsRequest.Builder> updatePublicSharingSettingsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedPricingPlanException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Use the
UpdatePublicSharingSettingsoperation to turn on or turn off the public sharing settings of an QuickSight dashboard.To use this operation, turn on session capacity pricing for your 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 QuickSight, see Using QuickSight with IAM in the QuickSight User Guide.
This is a convenience which creates an instance of the
UpdatePublicSharingSettingsRequest.Builderavoiding the need to create one manually viaUpdatePublicSharingSettingsRequest.builder()- Parameters:
updatePublicSharingSettingsRequest- AConsumerthat will call methods onUpdatePublicSharingSettingsRequest.Builderto create a request.- Returns:
- Result of the UpdatePublicSharingSettings operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 QuickSight. You can do this on the Manage QuickSight page.After capacity pricing is added, you can use the
GetDashboardEmbedUrlAPI operation with the--identity-type ANONYMOUSoption.InternalFailureException- An internal failure occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QuickSightException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateQPersonalizationConfiguration
default UpdateQPersonalizationConfigurationResponse updateQPersonalizationConfiguration(UpdateQPersonalizationConfigurationRequest updateQPersonalizationConfigurationRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Updates a personalization configuration.
- Parameters:
updateQPersonalizationConfigurationRequest-- Returns:
- Result of the UpdateQPersonalizationConfiguration operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateQPersonalizationConfiguration
default UpdateQPersonalizationConfigurationResponse updateQPersonalizationConfiguration(Consumer<UpdateQPersonalizationConfigurationRequest.Builder> updateQPersonalizationConfigurationRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Updates a personalization configuration.
This is a convenience which creates an instance of the
UpdateQPersonalizationConfigurationRequest.Builderavoiding the need to create one manually viaUpdateQPersonalizationConfigurationRequest.builder()- Parameters:
updateQPersonalizationConfigurationRequest- AConsumerthat will call methods onUpdateQPersonalizationConfigurationRequest.Builderto create a request.- Returns:
- Result of the UpdateQPersonalizationConfiguration operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateQuickSightQSearchConfiguration
default UpdateQuickSightQSearchConfigurationResponse updateQuickSightQSearchConfiguration(UpdateQuickSightQSearchConfigurationRequest updateQuickSightQSearchConfigurationRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the state of a QuickSight Q Search configuration.
- Parameters:
updateQuickSightQSearchConfigurationRequest-- Returns:
- Result of the UpdateQuickSightQSearchConfiguration operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateQuickSightQSearchConfiguration
default UpdateQuickSightQSearchConfigurationResponse updateQuickSightQSearchConfiguration(Consumer<UpdateQuickSightQSearchConfigurationRequest.Builder> updateQuickSightQSearchConfigurationRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, ThrottlingException, ResourceNotFoundException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the state of a QuickSight Q Search configuration.
This is a convenience which creates an instance of the
UpdateQuickSightQSearchConfigurationRequest.Builderavoiding the need to create one manually viaUpdateQuickSightQSearchConfigurationRequest.builder()- Parameters:
updateQuickSightQSearchConfigurationRequest- AConsumerthat will call methods onUpdateQuickSightQSearchConfigurationRequest.Builderto create a request.- Returns:
- Result of the UpdateQuickSightQSearchConfiguration operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateRefreshSchedule
default UpdateRefreshScheduleResponse updateRefreshSchedule(UpdateRefreshScheduleRequest updateRefreshScheduleRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, PreconditionNotMetException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a refresh schedule for a dataset.
- Parameters:
updateRefreshScheduleRequest-- Returns:
- Result of the UpdateRefreshSchedule operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateRefreshSchedule
default UpdateRefreshScheduleResponse updateRefreshSchedule(Consumer<UpdateRefreshScheduleRequest.Builder> updateRefreshScheduleRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, LimitExceededException, PreconditionNotMetException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a refresh schedule for a dataset.
This is a convenience which creates an instance of the
UpdateRefreshScheduleRequest.Builderavoiding the need to create one manually viaUpdateRefreshScheduleRequest.builder()- Parameters:
updateRefreshScheduleRequest- AConsumerthat will call methods onUpdateRefreshScheduleRequest.Builderto create a request.- Returns:
- Result of the UpdateRefreshSchedule operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateRoleCustomPermission
default UpdateRoleCustomPermissionResponse updateRoleCustomPermission(UpdateRoleCustomPermissionRequest updateRoleCustomPermissionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Updates the custom permissions that are associated with a role.
- Parameters:
updateRoleCustomPermissionRequest-- Returns:
- Result of the UpdateRoleCustomPermission operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateRoleCustomPermission
default UpdateRoleCustomPermissionResponse updateRoleCustomPermission(Consumer<UpdateRoleCustomPermissionRequest.Builder> updateRoleCustomPermissionRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Updates the custom permissions that are associated with a role.
This is a convenience which creates an instance of the
UpdateRoleCustomPermissionRequest.Builderavoiding the need to create one manually viaUpdateRoleCustomPermissionRequest.builder()- Parameters:
updateRoleCustomPermissionRequest- AConsumerthat will call methods onUpdateRoleCustomPermissionRequest.Builderto create a request.- Returns:
- Result of the UpdateRoleCustomPermission operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateSPICECapacityConfiguration
default UpdateSpiceCapacityConfigurationResponse updateSPICECapacityConfiguration(UpdateSpiceCapacityConfigurationRequest updateSpiceCapacityConfigurationRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the SPICE capacity configuration for a QuickSight account.
- Parameters:
updateSpiceCapacityConfigurationRequest-- Returns:
- Result of the UpdateSPICECapacityConfiguration operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateSPICECapacityConfiguration
default UpdateSpiceCapacityConfigurationResponse updateSPICECapacityConfiguration(Consumer<UpdateSpiceCapacityConfigurationRequest.Builder> updateSpiceCapacityConfigurationRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the SPICE capacity configuration for a QuickSight account.
This is a convenience which creates an instance of the
UpdateSpiceCapacityConfigurationRequest.Builderavoiding the need to create one manually viaUpdateSpiceCapacityConfigurationRequest.builder()- Parameters:
updateSpiceCapacityConfigurationRequest- AConsumerthat will call methods onUpdateSpiceCapacityConfigurationRequest.Builderto create a request.- Returns:
- Result of the UpdateSPICECapacityConfiguration operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateTemplate
default UpdateTemplateResponse updateTemplate(UpdateTemplateRequest updateTemplateRequest) throws InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConflictException, LimitExceededException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a template from an existing Amazon QuickSight analysis or another template.
- Parameters:
updateTemplateRequest-- Returns:
- Result of the UpdateTemplate operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateTemplate
default UpdateTemplateResponse updateTemplate(Consumer<UpdateTemplateRequest.Builder> updateTemplateRequest) throws InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, ConflictException, LimitExceededException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a template from an existing Amazon QuickSight analysis or another template.
This is a convenience which creates an instance of the
UpdateTemplateRequest.Builderavoiding the need to create one manually viaUpdateTemplateRequest.builder()- Parameters:
updateTemplateRequest- AConsumerthat will call methods onUpdateTemplateRequest.Builderto create a request.- Returns:
- Result of the UpdateTemplate operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateTemplateAlias
default UpdateTemplateAliasResponse updateTemplateAlias(UpdateTemplateAliasRequest updateTemplateAliasRequest) throws ThrottlingException, ResourceNotFoundException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the template alias of a template.
- Parameters:
updateTemplateAliasRequest-- Returns:
- Result of the UpdateTemplateAlias operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateTemplateAlias
default UpdateTemplateAliasResponse updateTemplateAlias(Consumer<UpdateTemplateAliasRequest.Builder> updateTemplateAliasRequest) throws ThrottlingException, ResourceNotFoundException, ConflictException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the template alias of a template.
This is a convenience which creates an instance of the
UpdateTemplateAliasRequest.Builderavoiding the need to create one manually viaUpdateTemplateAliasRequest.builder()- Parameters:
updateTemplateAliasRequest- AConsumerthat will call methods onUpdateTemplateAliasRequest.Builderto create a request.- Returns:
- Result of the UpdateTemplateAlias operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateTemplatePermissions
default UpdateTemplatePermissionsResponse updateTemplatePermissions(UpdateTemplatePermissionsRequest updateTemplatePermissionsRequest) throws ThrottlingException, InvalidParameterValueException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the resource permissions for a template.
- Parameters:
updateTemplatePermissionsRequest-- Returns:
- Result of the UpdateTemplatePermissions operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateTemplatePermissions
default UpdateTemplatePermissionsResponse updateTemplatePermissions(Consumer<UpdateTemplatePermissionsRequest.Builder> updateTemplatePermissionsRequest) throws ThrottlingException, InvalidParameterValueException, ConflictException, ResourceNotFoundException, UnsupportedUserEditionException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the resource permissions for a template.
This is a convenience which creates an instance of the
UpdateTemplatePermissionsRequest.Builderavoiding the need to create one manually viaUpdateTemplatePermissionsRequest.builder()- Parameters:
updateTemplatePermissionsRequest- AConsumerthat will call methods onUpdateTemplatePermissionsRequest.Builderto create a request.- Returns:
- Result of the UpdateTemplatePermissions operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateTheme
default UpdateThemeResponse updateTheme(UpdateThemeRequest updateThemeRequest) throws AccessDeniedException, InvalidParameterValueException, LimitExceededException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a theme.
- Parameters:
updateThemeRequest-- Returns:
- Result of the UpdateTheme operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateTheme
default UpdateThemeResponse updateTheme(Consumer<UpdateThemeRequest.Builder> updateThemeRequest) throws AccessDeniedException, InvalidParameterValueException, LimitExceededException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a theme.
This is a convenience which creates an instance of the
UpdateThemeRequest.Builderavoiding the need to create one manually viaUpdateThemeRequest.builder()- Parameters:
updateThemeRequest- AConsumerthat will call methods onUpdateThemeRequest.Builderto create a request.- Returns:
- Result of the UpdateTheme operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateThemeAlias
default UpdateThemeAliasResponse updateThemeAlias(UpdateThemeAliasRequest updateThemeAliasRequest) throws ConflictException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates an alias of a theme.
- Parameters:
updateThemeAliasRequest-- Returns:
- Result of the UpdateThemeAlias operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateThemeAlias
default UpdateThemeAliasResponse updateThemeAlias(Consumer<UpdateThemeAliasRequest.Builder> updateThemeAliasRequest) throws ConflictException, InvalidParameterValueException, ResourceExistsException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates an alias of a theme.
This is a convenience which creates an instance of the
UpdateThemeAliasRequest.Builderavoiding the need to create one manually viaUpdateThemeAliasRequest.builder()- Parameters:
updateThemeAliasRequest- AConsumerthat will call methods onUpdateThemeAliasRequest.Builderto create a request.- Returns:
- Result of the UpdateThemeAlias operation returned by the service.
- Throws:
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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateThemePermissions
default UpdateThemePermissionsResponse updateThemePermissions(UpdateThemePermissionsRequest updateThemePermissionsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example
"quicksight:DescribeTheme".Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions:
-
User
-
"quicksight:DescribeTheme" -
"quicksight:DescribeThemeAlias" -
"quicksight:ListThemeAliases" -
"quicksight:ListThemeVersions"
-
-
Owner
-
"quicksight:DescribeTheme" -
"quicksight:DescribeThemeAlias" -
"quicksight:ListThemeAliases" -
"quicksight:ListThemeVersions" -
"quicksight:DeleteTheme" -
"quicksight:UpdateTheme" -
"quicksight:CreateThemeAlias" -
"quicksight:DeleteThemeAlias" -
"quicksight:UpdateThemeAlias" -
"quicksight:UpdateThemePermissions" -
"quicksight:DescribeThemePermissions"
-
-
To specify no permissions, omit the permissions list.
- Parameters:
updateThemePermissionsRequest-- Returns:
- Result of the UpdateThemePermissions operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
updateThemePermissions
default UpdateThemePermissionsResponse updateThemePermissions(Consumer<UpdateThemePermissionsRequest.Builder> updateThemePermissionsRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example
"quicksight:DescribeTheme".Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions:
-
User
-
"quicksight:DescribeTheme" -
"quicksight:DescribeThemeAlias" -
"quicksight:ListThemeAliases" -
"quicksight:ListThemeVersions"
-
-
Owner
-
"quicksight:DescribeTheme" -
"quicksight:DescribeThemeAlias" -
"quicksight:ListThemeAliases" -
"quicksight:ListThemeVersions" -
"quicksight:DeleteTheme" -
"quicksight:UpdateTheme" -
"quicksight:CreateThemeAlias" -
"quicksight:DeleteThemeAlias" -
"quicksight:UpdateThemeAlias" -
"quicksight:UpdateThemePermissions" -
"quicksight:DescribeThemePermissions"
-
-
To specify no permissions, omit the permissions list.
This is a convenience which creates an instance of the
UpdateThemePermissionsRequest.Builderavoiding the need to create one manually viaUpdateThemePermissionsRequest.builder()- Parameters:
updateThemePermissionsRequest- AConsumerthat will call methods onUpdateThemePermissionsRequest.Builderto create a request.- Returns:
- Result of the UpdateThemePermissions operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
updateTopic
default UpdateTopicResponse updateTopic(UpdateTopicRequest updateTopicRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceNotFoundException, ResourceExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a topic.
- Parameters:
updateTopicRequest-- Returns:
- Result of the UpdateTopic operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateTopic
default UpdateTopicResponse updateTopic(Consumer<UpdateTopicRequest.Builder> updateTopicRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceNotFoundException, ResourceExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a topic.
This is a convenience which creates an instance of the
UpdateTopicRequest.Builderavoiding the need to create one manually viaUpdateTopicRequest.builder()- Parameters:
updateTopicRequest- AConsumerthat will call methods onUpdateTopicRequest.Builderto create a request.- Returns:
- Result of the UpdateTopic operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateTopicPermissions
default UpdateTopicPermissionsResponse updateTopicPermissions(UpdateTopicPermissionsRequest updateTopicPermissionsRequest) throws AccessDeniedException, ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, UnsupportedUserEditionException, ConflictException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the permissions of a topic.
- Parameters:
updateTopicPermissionsRequest-- Returns:
- Result of the UpdateTopicPermissions operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateTopicPermissions
default UpdateTopicPermissionsResponse updateTopicPermissions(Consumer<UpdateTopicPermissionsRequest.Builder> updateTopicPermissionsRequest) throws AccessDeniedException, ThrottlingException, InvalidParameterValueException, ResourceNotFoundException, UnsupportedUserEditionException, ConflictException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates the permissions of a topic.
This is a convenience which creates an instance of the
UpdateTopicPermissionsRequest.Builderavoiding the need to create one manually viaUpdateTopicPermissionsRequest.builder()- Parameters:
updateTopicPermissionsRequest- AConsumerthat will call methods onUpdateTopicPermissionsRequest.Builderto create a request.- Returns:
- Result of the UpdateTopicPermissions operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateTopicRefreshSchedule
default UpdateTopicRefreshScheduleResponse updateTopicRefreshSchedule(UpdateTopicRefreshScheduleRequest updateTopicRefreshScheduleRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceNotFoundException, ResourceExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a topic refresh schedule.
- Parameters:
updateTopicRefreshScheduleRequest-- Returns:
- Result of the UpdateTopicRefreshSchedule operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateTopicRefreshSchedule
default UpdateTopicRefreshScheduleResponse updateTopicRefreshSchedule(Consumer<UpdateTopicRefreshScheduleRequest.Builder> updateTopicRefreshScheduleRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceNotFoundException, ResourceExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a topic refresh schedule.
This is a convenience which creates an instance of the
UpdateTopicRefreshScheduleRequest.Builderavoiding the need to create one manually viaUpdateTopicRefreshScheduleRequest.builder()- Parameters:
updateTopicRefreshScheduleRequest- AConsumerthat will call methods onUpdateTopicRefreshScheduleRequest.Builderto create a request.- Returns:
- Result of the UpdateTopicRefreshSchedule operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateUser
default UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Updates an Amazon QuickSight user.
- Parameters:
updateUserRequest-- Returns:
- Result of the UpdateUser operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateUser
default UpdateUserResponse updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) throws AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Updates an Amazon QuickSight user.
This is a convenience which creates an instance of the
UpdateUserRequest.Builderavoiding the need to create one manually viaUpdateUserRequest.builder()- Parameters:
updateUserRequest- AConsumerthat will call methods onUpdateUserRequest.Builderto create a request.- Returns:
- Result of the UpdateUser operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateUserCustomPermission
default UpdateUserCustomPermissionResponse updateUserCustomPermission(UpdateUserCustomPermissionRequest updateUserCustomPermissionRequest) throws ConflictException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Updates a custom permissions profile for a user.
- Parameters:
updateUserCustomPermissionRequest-- Returns:
- Result of the UpdateUserCustomPermission operation returned by the service.
- Throws:
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.InvalidParameterValueException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateUserCustomPermission
default UpdateUserCustomPermissionResponse updateUserCustomPermission(Consumer<UpdateUserCustomPermissionRequest.Builder> updateUserCustomPermissionRequest) throws ConflictException, AccessDeniedException, InvalidParameterValueException, ResourceNotFoundException, ThrottlingException, PreconditionNotMetException, InternalFailureException, ResourceUnavailableException, AwsServiceException, SdkClientException, QuickSightException
Updates a custom permissions profile for a user.
This is a convenience which creates an instance of the
UpdateUserCustomPermissionRequest.Builderavoiding the need to create one manually viaUpdateUserCustomPermissionRequest.builder()- Parameters:
updateUserCustomPermissionRequest- AConsumerthat will call methods onUpdateUserCustomPermissionRequest.Builderto create a request.- Returns:
- Result of the UpdateUserCustomPermission operation returned by the service.
- Throws:
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.InvalidParameterValueException- 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateVPCConnection
default UpdateVpcConnectionResponse updateVPCConnection(UpdateVpcConnectionRequest updateVpcConnectionRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a VPC connection.
- Parameters:
updateVpcConnectionRequest-- Returns:
- Result of the UpdateVPCConnection operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateVPCConnection
default UpdateVpcConnectionResponse updateVPCConnection(Consumer<UpdateVpcConnectionRequest.Builder> updateVpcConnectionRequest) throws AccessDeniedException, ConflictException, InvalidParameterValueException, LimitExceededException, ResourceNotFoundException, ThrottlingException, UnsupportedUserEditionException, InternalFailureException, AwsServiceException, SdkClientException, QuickSightException
Updates a VPC connection.
This is a convenience which creates an instance of the
UpdateVpcConnectionRequest.Builderavoiding the need to create one manually viaUpdateVpcConnectionRequest.builder()- Parameters:
updateVpcConnectionRequest- AConsumerthat will call methods onUpdateVpcConnectionRequest.Builderto create a request.- Returns:
- Result of the UpdateVPCConnection operation returned by the service.
- Throws:
AccessDeniedException- You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your 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 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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static QuickSightClient create()
Create aQuickSightClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static QuickSightClientBuilder builder()
Create a builder that can be used to configure and create aQuickSightClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default QuickSightServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-