com.amazonaws.services.quicksight.AmazonQuickSight Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-quicksight Show documentation
Show all versions of aws-java-sdk-quicksight Show documentation
The AWS Java SDK for Amazon QuickSight module holds the client classes that are used for communicating with Amazon QuickSight Service
/*
* Copyright 2014-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.quicksight;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.quicksight.model.*;
/**
* Interface for accessing Amazon QuickSight.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.quicksight.AbstractAmazonQuickSight} instead.
*
*
* Amazon QuickSight API Reference
*
* Amazon QuickSight is a fully managed, serverless business intelligence service for the AWS 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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonQuickSight {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "quicksight";
/**
*
* Cancels an ongoing ingestion of data into SPICE.
*
*
* @param cancelIngestionRequest
* @return Result of the CancelIngestion operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws ResourceExistsException
* The resource specified already exists.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.CancelIngestion
* @see AWS API
* Documentation
*/
CancelIngestionResult cancelIngestion(CancelIngestionRequest cancelIngestionRequest);
/**
*
* Creates a dashboard from a template. To first create a template, see the CreateTemplate API.
*
*
* A dashboard is an entity in QuickSight which identifies Quicksight reports, created from analyses. QuickSight
* dashboards are sharable. With the right permissions, you can create scheduled email reports from them. The
* CreateDashboard, DescribeDashboard and ListDashboardsByUser APIs act on
* the dashboard entity. If you have the correct permissions, you can create a dashboard from a template that exists
* in a different AWS account.
*
*
* @param createDashboardRequest
* @return Result of the CreateDashboard operation returned by the service.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ThrottlingException
* Access is throttled.
* @throws ResourceExistsException
* The resource specified already exists.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @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.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.CreateDashboard
* @see AWS API
* Documentation
*/
CreateDashboardResult createDashboard(CreateDashboardRequest createDashboardRequest);
/**
*
* Creates a dataset.
*
*
* @param createDataSetRequest
* @return Result of the CreateDataSet operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws LimitExceededException
* A limit is exceeded.
* @throws ResourceExistsException
* The resource specified already exists.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @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.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.CreateDataSet
* @see AWS API
* Documentation
*/
CreateDataSetResult createDataSet(CreateDataSetRequest createDataSetRequest);
/**
*
* Creates a data source.
*
*
* @param createDataSourceRequest
* @return Result of the CreateDataSource operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws LimitExceededException
* A limit is exceeded.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ResourceExistsException
* The resource specified already exists.
* @throws ThrottlingException
* Access is throttled.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.CreateDataSource
* @see AWS
* API Documentation
*/
CreateDataSourceResult createDataSource(CreateDataSourceRequest createDataSourceRequest);
/**
*
* Creates an Amazon QuickSight group.
*
*
* The permissions resource is
* arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name>
* .
*
*
* The response is a group object.
*
*
* @param createGroupRequest
* The request object for this operation.
* @return Result of the CreateGroup operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceExistsException
* The resource specified already exists.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws PreconditionNotMetException
* One or more preconditions aren't met.
* @throws LimitExceededException
* A limit is exceeded.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ResourceUnavailableException
* This resource is currently unavailable.
* @sample AmazonQuickSight.CreateGroup
* @see AWS API
* Documentation
*/
CreateGroupResult createGroup(CreateGroupRequest createGroupRequest);
/**
*
* Adds an Amazon QuickSight user to an Amazon QuickSight group.
*
*
* @param createGroupMembershipRequest
* @return Result of the CreateGroupMembership operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws PreconditionNotMetException
* One or more preconditions aren't met.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ResourceUnavailableException
* This resource is currently unavailable.
* @sample AmazonQuickSight.CreateGroupMembership
* @see AWS API Documentation
*/
CreateGroupMembershipResult createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest);
/**
*
* Creates an assignment with one specified IAM policy Amazon Resource Name (ARN) and will assigned to specified
* groups or users of QuickSight. Users and groups need to be in the same namespace.
*
*
* @param createIAMPolicyAssignmentRequest
* @return Result of the CreateIAMPolicyAssignment operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceExistsException
* The resource specified already exists.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws ConcurrentUpdatingException
* A resource is already in an "actionable" state that must complete before a new update can be applied.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.CreateIAMPolicyAssignment
* @see AWS API Documentation
*/
CreateIAMPolicyAssignmentResult createIAMPolicyAssignment(CreateIAMPolicyAssignmentRequest createIAMPolicyAssignmentRequest);
/**
*
* Creates and starts a new SPICE ingestion on a dataset
*
*
* 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 AWS Knowledge Center. Tags
* are visible on the tagged dataset, but not on the ingestion resource.
*
*
* @param createIngestionRequest
* @return Result of the CreateIngestion operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws LimitExceededException
* A limit is exceeded.
* @throws ResourceExistsException
* The resource specified already exists.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.CreateIngestion
* @see AWS API
* Documentation
*/
CreateIngestionResult createIngestion(CreateIngestionRequest createIngestionRequest);
/**
*
* Creates a template from an existing QuickSight analysis or template. The resulting template can be used to create
* a dashboard.
*
*
* A template is an entity in QuickSight which encapsulates the metadata required to create an analysis that can be
* used to create dashboard. It adds a layer of abstraction by use placeholders to replace the dataset associated
* with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets
* which follow the same schema that was used to create the source analysis and template.
*
*
* @param createTemplateRequest
* @return Result of the CreateTemplate operation returned by the service.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws ResourceExistsException
* The resource specified already exists.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws LimitExceededException
* A limit is exceeded.
* @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.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.CreateTemplate
* @see AWS API
* Documentation
*/
CreateTemplateResult createTemplate(CreateTemplateRequest createTemplateRequest);
/**
*
* Creates a template alias for a template.
*
*
* @param createTemplateAliasRequest
* @return Result of the CreateTemplateAlias operation returned by the service.
* @throws ThrottlingException
* Access is throttled.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ResourceExistsException
* The resource specified already exists.
* @throws LimitExceededException
* A limit is exceeded.
* @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.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.CreateTemplateAlias
* @see AWS
* API Documentation
*/
CreateTemplateAliasResult createTemplateAlias(CreateTemplateAliasRequest createTemplateAliasRequest);
/**
*
* Deletes a dashboard.
*
*
* @param deleteDashboardRequest
* @return Result of the DeleteDashboard operation returned by the service.
* @throws ThrottlingException
* Access is throttled.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @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.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.DeleteDashboard
* @see AWS API
* Documentation
*/
DeleteDashboardResult deleteDashboard(DeleteDashboardRequest deleteDashboardRequest);
/**
*
* Deletes a dataset.
*
*
* @param deleteDataSetRequest
* @return Result of the DeleteDataSet operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ThrottlingException
* Access is throttled.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.DeleteDataSet
* @see AWS API
* Documentation
*/
DeleteDataSetResult deleteDataSet(DeleteDataSetRequest deleteDataSetRequest);
/**
*
* Deletes the data source permanently. This action breaks all the datasets that reference the deleted data source.
*
*
* @param deleteDataSourceRequest
* @return Result of the DeleteDataSource operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ThrottlingException
* Access is throttled.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.DeleteDataSource
* @see AWS
* API Documentation
*/
DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest);
/**
*
* Removes a user group from Amazon QuickSight.
*
*
* @param deleteGroupRequest
* @return Result of the DeleteGroup operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws PreconditionNotMetException
* One or more preconditions aren't met.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ResourceUnavailableException
* This resource is currently unavailable.
* @sample AmazonQuickSight.DeleteGroup
* @see AWS API
* Documentation
*/
DeleteGroupResult deleteGroup(DeleteGroupRequest deleteGroupRequest);
/**
*
* Removes a user from a group so that the user is no longer a member of the group.
*
*
* @param deleteGroupMembershipRequest
* @return Result of the DeleteGroupMembership operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws PreconditionNotMetException
* One or more preconditions aren't met.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ResourceUnavailableException
* This resource is currently unavailable.
* @sample AmazonQuickSight.DeleteGroupMembership
* @see AWS API Documentation
*/
DeleteGroupMembershipResult deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest);
/**
*
* Deletes an existing assignment.
*
*
* @param deleteIAMPolicyAssignmentRequest
* @return Result of the DeleteIAMPolicyAssignment operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceExistsException
* The resource specified already exists.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws ConcurrentUpdatingException
* A resource is already in an "actionable" state that must complete before a new update can be applied.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.DeleteIAMPolicyAssignment
* @see AWS API Documentation
*/
DeleteIAMPolicyAssignmentResult deleteIAMPolicyAssignment(DeleteIAMPolicyAssignmentRequest deleteIAMPolicyAssignmentRequest);
/**
*
* Deletes a template.
*
*
* @param deleteTemplateRequest
* @return Result of the DeleteTemplate operation returned by the service.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws LimitExceededException
* A limit is exceeded.
* @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.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.DeleteTemplate
* @see AWS API
* Documentation
*/
DeleteTemplateResult deleteTemplate(DeleteTemplateRequest deleteTemplateRequest);
/**
*
* Update template alias of given template.
*
*
* @param deleteTemplateAliasRequest
* @return Result of the DeleteTemplateAlias operation returned by the service.
* @throws ThrottlingException
* Access is throttled.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @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.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.DeleteTemplateAlias
* @see AWS
* API Documentation
*/
DeleteTemplateAliasResult deleteTemplateAlias(DeleteTemplateAliasRequest deleteTemplateAliasRequest);
/**
*
* Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management
* (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.
*
*
* @param deleteUserRequest
* @return Result of the DeleteUser operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ResourceUnavailableException
* This resource is currently unavailable.
* @sample AmazonQuickSight.DeleteUser
* @see AWS API
* Documentation
*/
DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest);
/**
*
* Deletes a user identified by its principal ID.
*
*
* @param deleteUserByPrincipalIdRequest
* @return Result of the DeleteUserByPrincipalId operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ResourceUnavailableException
* This resource is currently unavailable.
* @sample AmazonQuickSight.DeleteUserByPrincipalId
* @see AWS API Documentation
*/
DeleteUserByPrincipalIdResult deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest deleteUserByPrincipalIdRequest);
/**
*
* Provides a summary for a dashboard.
*
*
* @param describeDashboardRequest
* @return Result of the DescribeDashboard operation returned by the service.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws ThrottlingException
* Access is throttled.
* @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.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.DescribeDashboard
* @see AWS
* API Documentation
*/
DescribeDashboardResult describeDashboard(DescribeDashboardRequest describeDashboardRequest);
/**
*
* Describes read and write permissions on a dashboard.
*
*
* @param describeDashboardPermissionsRequest
* @return Result of the DescribeDashboardPermissions operation returned by the service.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @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.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.DescribeDashboardPermissions
* @see AWS API Documentation
*/
DescribeDashboardPermissionsResult describeDashboardPermissions(DescribeDashboardPermissionsRequest describeDashboardPermissionsRequest);
/**
*
* Describes a dataset.
*
*
* @param describeDataSetRequest
* @return Result of the DescribeDataSet operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ThrottlingException
* Access is throttled.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.DescribeDataSet
* @see AWS API
* Documentation
*/
DescribeDataSetResult describeDataSet(DescribeDataSetRequest describeDataSetRequest);
/**
*
* Describes the permissions on a dataset.
*
*
* The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
*
*
* @param describeDataSetPermissionsRequest
* @return Result of the DescribeDataSetPermissions operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ThrottlingException
* Access is throttled.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.DescribeDataSetPermissions
* @see AWS API Documentation
*/
DescribeDataSetPermissionsResult describeDataSetPermissions(DescribeDataSetPermissionsRequest describeDataSetPermissionsRequest);
/**
*
* Describes a data source.
*
*
* @param describeDataSourceRequest
* @return Result of the DescribeDataSource operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ThrottlingException
* Access is throttled.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.DescribeDataSource
* @see AWS
* API Documentation
*/
DescribeDataSourceResult describeDataSource(DescribeDataSourceRequest describeDataSourceRequest);
/**
*
* Describes the resource permissions for a data source.
*
*
* @param describeDataSourcePermissionsRequest
* @return Result of the DescribeDataSourcePermissions operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ThrottlingException
* Access is throttled.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.DescribeDataSourcePermissions
* @see AWS API Documentation
*/
DescribeDataSourcePermissionsResult describeDataSourcePermissions(DescribeDataSourcePermissionsRequest describeDataSourcePermissionsRequest);
/**
*
* Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
*
*
* @param describeGroupRequest
* @return Result of the DescribeGroup operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws PreconditionNotMetException
* One or more preconditions aren't met.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ResourceUnavailableException
* This resource is currently unavailable.
* @sample AmazonQuickSight.DescribeGroup
* @see AWS API
* Documentation
*/
DescribeGroupResult describeGroup(DescribeGroupRequest describeGroupRequest);
/**
*
* Describes an existing IAMPolicy Assignment by specified assignment name.
*
*
* @param describeIAMPolicyAssignmentRequest
* @return Result of the DescribeIAMPolicyAssignment operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws InvalidNextTokenException
* The NextToken value isn't valid.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.DescribeIAMPolicyAssignment
* @see AWS API Documentation
*/
DescribeIAMPolicyAssignmentResult describeIAMPolicyAssignment(DescribeIAMPolicyAssignmentRequest describeIAMPolicyAssignmentRequest);
/**
*
* Describes a SPICE ingestion.
*
*
* @param describeIngestionRequest
* @return Result of the DescribeIngestion operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws ResourceExistsException
* The resource specified already exists.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.DescribeIngestion
* @see AWS
* API Documentation
*/
DescribeIngestionResult describeIngestion(DescribeIngestionRequest describeIngestionRequest);
/**
*
* Describes a template's metadata.
*
*
* @param describeTemplateRequest
* @return Result of the DescribeTemplate operation returned by the service.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws ResourceExistsException
* The resource specified already exists.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @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.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.DescribeTemplate
* @see AWS
* API Documentation
*/
DescribeTemplateResult describeTemplate(DescribeTemplateRequest describeTemplateRequest);
/**
*
* Describes the template aliases of a template.
*
*
* @param describeTemplateAliasRequest
* @return Result of the DescribeTemplateAlias operation returned by the service.
* @throws ThrottlingException
* Access is throttled.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @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.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.DescribeTemplateAlias
* @see AWS API Documentation
*/
DescribeTemplateAliasResult describeTemplateAlias(DescribeTemplateAliasRequest describeTemplateAliasRequest);
/**
*
* Describes read and write permissions on a template.
*
*
* @param describeTemplatePermissionsRequest
* @return Result of the DescribeTemplatePermissions operation returned by the service.
* @throws ThrottlingException
* Access is throttled.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @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.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.DescribeTemplatePermissions
* @see AWS API Documentation
*/
DescribeTemplatePermissionsResult describeTemplatePermissions(DescribeTemplatePermissionsRequest describeTemplatePermissionsRequest);
/**
*
* Returns information about a user, given the user name.
*
*
* @param describeUserRequest
* @return Result of the DescribeUser operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ResourceUnavailableException
* This resource is currently unavailable.
* @sample AmazonQuickSight.DescribeUser
* @see AWS API
* Documentation
*/
DescribeUserResult describeUser(DescribeUserRequest describeUserRequest);
/**
*
* Generates a server-side embeddable URL and authorization code. Before this can work properly, first you need to
* configure the dashboards and user permissions. For more information, see the Amazon QuickSight User Guide section
* on Embedding Amazon
* QuickSight Dashboards or see the Amazon QuickSight API Reference section on Embedding
* Amazon QuickSight Dashboards .
*
*
* Currently, you can use GetDashboardEmbedURL only from the server, not from the user’s browser.
*
*
* @param getDashboardEmbedUrlRequest
* @return Result of the GetDashboardEmbedUrl operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceExistsException
* The resource specified already exists.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws DomainNotWhitelistedException
* The domain specified is not on the allowlist. All domains for embedded dashboards must be added to the
* approved list by an Amazon QuickSight admin.
* @throws QuickSightUserNotFoundException
* The user is not found. This error can happen in any operation that requires finding a user based on a
* provided user name, such as DeleteUser, DescribeUser, and so on.
* @throws IdentityTypeNotSupportedException
* The identity type specified is not supported. Supported identity types include IAM and QUICKSIGHT.
* @throws SessionLifetimeInMinutesInvalidException
* The number of minutes specified for the lifetime of a session is not valid. The session lifetime must be
* from 15 to 600 minutes.
* @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.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.GetDashboardEmbedUrl
* @see AWS API Documentation
*/
GetDashboardEmbedUrlResult getDashboardEmbedUrl(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest);
/**
*
* Lists all the versions of the dashboards in the Quicksight subscription.
*
*
* @param listDashboardVersionsRequest
* @return Result of the ListDashboardVersions operation returned by the service.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws InvalidNextTokenException
* The NextToken value isn't valid.
* @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.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.ListDashboardVersions
* @see AWS API Documentation
*/
ListDashboardVersionsResult listDashboardVersions(ListDashboardVersionsRequest listDashboardVersionsRequest);
/**
*
* Lists dashboards in the AWS account.
*
*
* @param listDashboardsRequest
* @return Result of the ListDashboards operation returned by the service.
* @throws ThrottlingException
* Access is throttled.
* @throws InvalidNextTokenException
* The NextToken value isn't valid.
* @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.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.ListDashboards
* @see AWS API
* Documentation
*/
ListDashboardsResult listDashboards(ListDashboardsRequest listDashboardsRequest);
/**
*
* Lists all of the datasets belonging to this account in an AWS region.
*
*
* The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
*
*
* @param listDataSetsRequest
* @return Result of the ListDataSets operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ThrottlingException
* Access is throttled.
* @throws InvalidNextTokenException
* The NextToken value isn't valid.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.ListDataSets
* @see AWS API
* Documentation
*/
ListDataSetsResult listDataSets(ListDataSetsRequest listDataSetsRequest);
/**
*
* Lists data sources in current AWS Region that belong to this AWS account.
*
*
* @param listDataSourcesRequest
* @return Result of the ListDataSources operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ThrottlingException
* Access is throttled.
* @throws InvalidNextTokenException
* The NextToken value isn't valid.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.ListDataSources
* @see AWS API
* Documentation
*/
ListDataSourcesResult listDataSources(ListDataSourcesRequest listDataSourcesRequest);
/**
*
* Lists member users in a group.
*
*
* @param listGroupMembershipsRequest
* @return Result of the ListGroupMemberships operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws InvalidNextTokenException
* The NextToken value isn't valid.
* @throws PreconditionNotMetException
* One or more preconditions aren't met.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ResourceUnavailableException
* This resource is currently unavailable.
* @sample AmazonQuickSight.ListGroupMemberships
* @see AWS API Documentation
*/
ListGroupMembershipsResult listGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest);
/**
*
* Lists all user groups in Amazon QuickSight.
*
*
* @param listGroupsRequest
* @return Result of the ListGroups operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws InvalidNextTokenException
* The NextToken value isn't valid.
* @throws PreconditionNotMetException
* One or more preconditions aren't met.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ResourceUnavailableException
* This resource is currently unavailable.
* @sample AmazonQuickSight.ListGroups
* @see AWS API
* Documentation
*/
ListGroupsResult listGroups(ListGroupsRequest listGroupsRequest);
/**
*
* Lists assignments in current QuickSight account.
*
*
* @param listIAMPolicyAssignmentsRequest
* @return Result of the ListIAMPolicyAssignments operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws InvalidNextTokenException
* The NextToken value isn't valid.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.ListIAMPolicyAssignments
* @see AWS API Documentation
*/
ListIAMPolicyAssignmentsResult listIAMPolicyAssignments(ListIAMPolicyAssignmentsRequest listIAMPolicyAssignmentsRequest);
/**
*
* Lists all the assignments and the Amazon Resource Names (ARNs) for the associated IAM policies assigned to the
* specified user and the group or groups that the user belongs to.
*
*
* @param listIAMPolicyAssignmentsForUserRequest
* @return Result of the ListIAMPolicyAssignmentsForUser operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceExistsException
* The resource specified already exists.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws ConcurrentUpdatingException
* A resource is already in an "actionable" state that must complete before a new update can be applied.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.ListIAMPolicyAssignmentsForUser
* @see AWS API Documentation
*/
ListIAMPolicyAssignmentsForUserResult listIAMPolicyAssignmentsForUser(ListIAMPolicyAssignmentsForUserRequest listIAMPolicyAssignmentsForUserRequest);
/**
*
* Lists the history of SPICE ingestions for a dataset.
*
*
* @param listIngestionsRequest
* @return Result of the ListIngestions operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws ResourceExistsException
* The resource specified already exists.
* @throws InvalidNextTokenException
* The NextToken value isn't valid.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.ListIngestions
* @see AWS API
* Documentation
*/
ListIngestionsResult listIngestions(ListIngestionsRequest listIngestionsRequest);
/**
*
* Lists the tags assigned to a resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.ListTagsForResource
* @see AWS
* API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Lists all the aliases of a template.
*
*
* @param listTemplateAliasesRequest
* @return Result of the ListTemplateAliases operation returned by the service.
* @throws ThrottlingException
* Access is throttled.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @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.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.ListTemplateAliases
* @see AWS
* API Documentation
*/
ListTemplateAliasesResult listTemplateAliases(ListTemplateAliasesRequest listTemplateAliasesRequest);
/**
*
* Lists all the versions of the templates in the Quicksight account.
*
*
* @param listTemplateVersionsRequest
* @return Result of the ListTemplateVersions operation returned by the service.
* @throws ThrottlingException
* Access is throttled.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws InvalidNextTokenException
* The NextToken value isn't valid.
* @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.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.ListTemplateVersions
* @see AWS API Documentation
*/
ListTemplateVersionsResult listTemplateVersions(ListTemplateVersionsRequest listTemplateVersionsRequest);
/**
*
* Lists all the templates in the QuickSight account.
*
*
* @param listTemplatesRequest
* @return Result of the ListTemplates operation returned by the service.
* @throws ThrottlingException
* Access is throttled.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws InvalidNextTokenException
* The NextToken value isn't valid.
* @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.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.ListTemplates
* @see AWS API
* Documentation
*/
ListTemplatesResult listTemplates(ListTemplatesRequest listTemplatesRequest);
/**
*
* Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
*
*
* @param listUserGroupsRequest
* @return Result of the ListUserGroups operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ResourceUnavailableException
* This resource is currently unavailable.
* @sample AmazonQuickSight.ListUserGroups
* @see AWS API
* Documentation
*/
ListUserGroupsResult listUserGroups(ListUserGroupsRequest listUserGroupsRequest);
/**
*
* Returns a list of all of the Amazon QuickSight users belonging to this account.
*
*
* @param listUsersRequest
* @return Result of the ListUsers operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws InvalidNextTokenException
* The NextToken value isn't valid.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ResourceUnavailableException
* This resource is currently unavailable.
* @sample AmazonQuickSight.ListUsers
* @see AWS API
* Documentation
*/
ListUsersResult listUsers(ListUsersRequest listUsersRequest);
/**
*
* Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM)
* identity or role specified in the request.
*
*
* @param registerUserRequest
* @return Result of the RegisterUser operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws LimitExceededException
* A limit is exceeded.
* @throws ResourceExistsException
* The resource specified already exists.
* @throws PreconditionNotMetException
* One or more preconditions aren't met.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ResourceUnavailableException
* This resource is currently unavailable.
* @sample AmazonQuickSight.RegisterUser
* @see AWS API
* Documentation
*/
RegisterUserResult registerUser(RegisterUserRequest registerUserRequest);
/**
*
* 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
* TagResource operation with a resource that already has tags. If you specify a new tag key for the
* resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is
* already associated with the resource, the new tag value that you specify replaces the previous value for that
* tag.
*
*
* You can associate as many as 50 tags with a resource. QuickSight supports tagging on data set, data source,
* dashboard, and template.
*
*
* Tagging for QuickSight works in a similar way to tagging for other AWS services, except for the following:
*
*
* -
*
* You can't use tags to track AWS costs for QuickSight. This restriction is because QuickSight costs are based on
* users and SPICE capacity, which aren't taggable resources.
*
*
* -
*
* QuickSight doesn't currently support the Tag Editor for AWS Resource Groups.
*
*
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws LimitExceededException
* A limit is exceeded.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes a tag or tags from a resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates a dashboard in the AWS account.
*
*
* @param updateDashboardRequest
* @return Result of the UpdateDashboard operation returned by the service.
* @throws ThrottlingException
* Access is throttled.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws LimitExceededException
* A limit is exceeded.
* @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.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.UpdateDashboard
* @see AWS API
* Documentation
*/
UpdateDashboardResult updateDashboard(UpdateDashboardRequest updateDashboardRequest);
/**
*
* Updates read and write permissions on a dashboard.
*
*
* @param updateDashboardPermissionsRequest
* @return Result of the UpdateDashboardPermissions operation returned by the service.
* @throws ThrottlingException
* Access is throttled.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @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.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.UpdateDashboardPermissions
* @see AWS API Documentation
*/
UpdateDashboardPermissionsResult updateDashboardPermissions(UpdateDashboardPermissionsRequest updateDashboardPermissionsRequest);
/**
*
* Updates the published version of a dashboard.
*
*
* @param updateDashboardPublishedVersionRequest
* @return Result of the UpdateDashboardPublishedVersion operation returned by the service.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ThrottlingException
* Access is throttled.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @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.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.UpdateDashboardPublishedVersion
* @see AWS API Documentation
*/
UpdateDashboardPublishedVersionResult updateDashboardPublishedVersion(UpdateDashboardPublishedVersionRequest updateDashboardPublishedVersionRequest);
/**
*
* Updates a dataset.
*
*
* @param updateDataSetRequest
* @return Result of the UpdateDataSet operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws LimitExceededException
* A limit is exceeded.
* @throws ThrottlingException
* Access is throttled.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @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.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.UpdateDataSet
* @see AWS API
* Documentation
*/
UpdateDataSetResult updateDataSet(UpdateDataSetRequest updateDataSetRequest);
/**
*
* Updates the permissions on a dataset.
*
*
* The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
*
*
* @param updateDataSetPermissionsRequest
* @return Result of the UpdateDataSetPermissions operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.UpdateDataSetPermissions
* @see AWS API Documentation
*/
UpdateDataSetPermissionsResult updateDataSetPermissions(UpdateDataSetPermissionsRequest updateDataSetPermissionsRequest);
/**
*
* Updates a data source.
*
*
* @param updateDataSourceRequest
* @return Result of the UpdateDataSource operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ThrottlingException
* Access is throttled.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.UpdateDataSource
* @see AWS
* API Documentation
*/
UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest updateDataSourceRequest);
/**
*
* Updates the permissions to a data source.
*
*
* @param updateDataSourcePermissionsRequest
* @return Result of the UpdateDataSourcePermissions operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.UpdateDataSourcePermissions
* @see AWS API Documentation
*/
UpdateDataSourcePermissionsResult updateDataSourcePermissions(UpdateDataSourcePermissionsRequest updateDataSourcePermissionsRequest);
/**
*
* Changes a group description.
*
*
* @param updateGroupRequest
* @return Result of the UpdateGroup operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws PreconditionNotMetException
* One or more preconditions aren't met.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ResourceUnavailableException
* This resource is currently unavailable.
* @sample AmazonQuickSight.UpdateGroup
* @see AWS API
* Documentation
*/
UpdateGroupResult updateGroup(UpdateGroupRequest updateGroupRequest);
/**
*
* Updates an existing assignment. This operation updates only the optional parameter or parameters that are
* specified in the request.
*
*
* @param updateIAMPolicyAssignmentRequest
* @return Result of the UpdateIAMPolicyAssignment operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceExistsException
* The resource specified already exists.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws ConcurrentUpdatingException
* A resource is already in an "actionable" state that must complete before a new update can be applied.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.UpdateIAMPolicyAssignment
* @see AWS API Documentation
*/
UpdateIAMPolicyAssignmentResult updateIAMPolicyAssignment(UpdateIAMPolicyAssignmentRequest updateIAMPolicyAssignmentRequest);
/**
*
* Updates a template from an existing QuickSight analysis.
*
*
* @param updateTemplateRequest
* @return Result of the UpdateTemplate operation returned by the service.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceExistsException
* The resource specified already exists.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws LimitExceededException
* A limit is exceeded.
* @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.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.UpdateTemplate
* @see AWS API
* Documentation
*/
UpdateTemplateResult updateTemplate(UpdateTemplateRequest updateTemplateRequest);
/**
*
* Updates the template alias of a template.
*
*
* @param updateTemplateAliasRequest
* @return Result of the UpdateTemplateAlias operation returned by the service.
* @throws ThrottlingException
* Access is throttled.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @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.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.UpdateTemplateAlias
* @see AWS
* API Documentation
*/
UpdateTemplateAliasResult updateTemplateAlias(UpdateTemplateAliasRequest updateTemplateAliasRequest);
/**
*
* Updates the permissions on a template.
*
*
* @param updateTemplatePermissionsRequest
* @return Result of the UpdateTemplatePermissions operation returned by the service.
* @throws ThrottlingException
* Access is throttled.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ConflictException
* Updating or deleting a resource can cause an inconsistent state.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @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.
* @throws InternalFailureException
* An internal failure occurred.
* @sample AmazonQuickSight.UpdateTemplatePermissions
* @see AWS API Documentation
*/
UpdateTemplatePermissionsResult updateTemplatePermissions(UpdateTemplatePermissionsRequest updateTemplatePermissionsRequest);
/**
*
* Updates an Amazon QuickSight user.
*
*
* @param updateUserRequest
* @return Result of the UpdateUser operation returned by the service.
* @throws AccessDeniedException
* You don't have access to this. The provided credentials couldn't be validated. You might not be
* authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight
* service, that your policies have the correct permissions, and that you are using the correct access keys.
* @throws InvalidParameterValueException
* One or more parameters don't have a valid value.
* @throws ResourceNotFoundException
* One or more resources can't be found.
* @throws ThrottlingException
* Access is throttled.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ResourceUnavailableException
* This resource is currently unavailable.
* @sample AmazonQuickSight.UpdateUser
* @see AWS API
* Documentation
*/
UpdateUserResult updateUser(UpdateUserRequest updateUserRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy