@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonQuickSightClient extends AmazonWebServiceClient implements AmazonQuickSight
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
static AmazonQuickSightClientBuilder |
builder() |
CancelIngestionResult |
cancelIngestion(CancelIngestionRequest request)
Cancels an ongoing ingestion of data into SPICE.
|
CreateDashboardResult |
createDashboard(CreateDashboardRequest request)
Creates a dashboard from a template.
|
CreateDataSetResult |
createDataSet(CreateDataSetRequest request)
Creates a dataset.
|
CreateDataSourceResult |
createDataSource(CreateDataSourceRequest request)
Creates a data source.
|
CreateGroupResult |
createGroup(CreateGroupRequest request)
Creates an Amazon QuickSight group.
|
CreateGroupMembershipResult |
createGroupMembership(CreateGroupMembershipRequest request)
Adds an Amazon QuickSight user to an Amazon QuickSight group.
|
CreateIAMPolicyAssignmentResult |
createIAMPolicyAssignment(CreateIAMPolicyAssignmentRequest request)
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN).
|
CreateIngestionResult |
createIngestion(CreateIngestionRequest request)
Creates and starts a new SPICE ingestion on a dataset
|
CreateTemplateResult |
createTemplate(CreateTemplateRequest request)
Creates a template from an existing QuickSight analysis or template.
|
CreateTemplateAliasResult |
createTemplateAlias(CreateTemplateAliasRequest request)
Creates a template alias for a template.
|
DeleteDashboardResult |
deleteDashboard(DeleteDashboardRequest request)
Deletes a dashboard.
|
DeleteDataSetResult |
deleteDataSet(DeleteDataSetRequest request)
Deletes a dataset.
|
DeleteDataSourceResult |
deleteDataSource(DeleteDataSourceRequest request)
Deletes the data source permanently.
|
DeleteGroupResult |
deleteGroup(DeleteGroupRequest request)
Removes a user group from Amazon QuickSight.
|
DeleteGroupMembershipResult |
deleteGroupMembership(DeleteGroupMembershipRequest request)
Removes a user from a group so that the user is no longer a member of the group.
|
DeleteIAMPolicyAssignmentResult |
deleteIAMPolicyAssignment(DeleteIAMPolicyAssignmentRequest request)
Deletes an existing IAM policy assignment.
|
DeleteTemplateResult |
deleteTemplate(DeleteTemplateRequest request)
Deletes a template.
|
DeleteTemplateAliasResult |
deleteTemplateAlias(DeleteTemplateAliasRequest request)
Deletes the item that the specified template alias points to.
|
DeleteUserResult |
deleteUser(DeleteUserRequest request)
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.
|
DeleteUserByPrincipalIdResult |
deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest request)
Deletes a user identified by its principal ID.
|
DescribeDashboardResult |
describeDashboard(DescribeDashboardRequest request)
Provides a summary for a dashboard.
|
DescribeDashboardPermissionsResult |
describeDashboardPermissions(DescribeDashboardPermissionsRequest request)
Describes read and write permissions for a dashboard.
|
DescribeDataSetResult |
describeDataSet(DescribeDataSetRequest request)
Describes a dataset.
|
DescribeDataSetPermissionsResult |
describeDataSetPermissions(DescribeDataSetPermissionsRequest request)
Describes the permissions on a dataset.
|
DescribeDataSourceResult |
describeDataSource(DescribeDataSourceRequest request)
Describes a data source.
|
DescribeDataSourcePermissionsResult |
describeDataSourcePermissions(DescribeDataSourcePermissionsRequest request)
Describes the resource permissions for a data source.
|
DescribeGroupResult |
describeGroup(DescribeGroupRequest request)
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
|
DescribeIAMPolicyAssignmentResult |
describeIAMPolicyAssignment(DescribeIAMPolicyAssignmentRequest request)
Describes an existing IAM policy assignment, as specified by the assignment name.
|
DescribeIngestionResult |
describeIngestion(DescribeIngestionRequest request)
Describes a SPICE ingestion.
|
DescribeTemplateResult |
describeTemplate(DescribeTemplateRequest request)
Describes a template's metadata.
|
DescribeTemplateAliasResult |
describeTemplateAlias(DescribeTemplateAliasRequest request)
Describes the template alias for a template.
|
DescribeTemplatePermissionsResult |
describeTemplatePermissions(DescribeTemplatePermissionsRequest request)
Describes read and write permissions on a template.
|
DescribeUserResult |
describeUser(DescribeUserRequest request)
Returns information about a user, given the user name.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetDashboardEmbedUrlResult |
getDashboardEmbedUrl(GetDashboardEmbedUrlRequest request)
Generates a server-side embeddable URL and authorization code.
|
ListDashboardsResult |
listDashboards(ListDashboardsRequest request)
Lists dashboards in an AWS account.
|
ListDashboardVersionsResult |
listDashboardVersions(ListDashboardVersionsRequest request)
Lists all the versions of the dashboards in the QuickSight subscription.
|
ListDataSetsResult |
listDataSets(ListDataSetsRequest request)
Lists all of the datasets belonging to the current AWS account in an AWS Region.
|
ListDataSourcesResult |
listDataSources(ListDataSourcesRequest request)
Lists data sources in current AWS Region that belong to this AWS account.
|
ListGroupMembershipsResult |
listGroupMemberships(ListGroupMembershipsRequest request)
Lists member users in a group.
|
ListGroupsResult |
listGroups(ListGroupsRequest request)
Lists all user groups in Amazon QuickSight.
|
ListIAMPolicyAssignmentsResult |
listIAMPolicyAssignments(ListIAMPolicyAssignmentsRequest request)
Lists IAM policy assignments in the current Amazon QuickSight account.
|
ListIAMPolicyAssignmentsForUserResult |
listIAMPolicyAssignmentsForUser(ListIAMPolicyAssignmentsForUserRequest request)
Lists all 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.
|
ListIngestionsResult |
listIngestions(ListIngestionsRequest request)
Lists the history of SPICE ingestions for a dataset.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists the tags assigned to a resource.
|
ListTemplateAliasesResult |
listTemplateAliases(ListTemplateAliasesRequest request)
Lists all the aliases of a template.
|
ListTemplatesResult |
listTemplates(ListTemplatesRequest request)
Lists all the templates in the current Amazon QuickSight account.
|
ListTemplateVersionsResult |
listTemplateVersions(ListTemplateVersionsRequest request)
Lists all the versions of the templates in the current Amazon QuickSight account.
|
ListUserGroupsResult |
listUserGroups(ListUserGroupsRequest request)
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
|
ListUsersResult |
listUsers(ListUsersRequest request)
Returns a list of all of the Amazon QuickSight users belonging to this account.
|
RegisterUserResult |
registerUser(RegisterUserRequest request)
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM)
identity or role specified in the request.
|
SearchDashboardsResult |
searchDashboards(SearchDashboardsRequest request)
Searchs for dashboards that belong to a user.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Assigns one or more tags (key-value pairs) to the specified QuickSight resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes a tag or tags from a resource.
|
UpdateDashboardResult |
updateDashboard(UpdateDashboardRequest request)
Updates a dashboard in an AWS account.
|
UpdateDashboardPermissionsResult |
updateDashboardPermissions(UpdateDashboardPermissionsRequest request)
Updates read and write permissions on a dashboard.
|
UpdateDashboardPublishedVersionResult |
updateDashboardPublishedVersion(UpdateDashboardPublishedVersionRequest request)
Updates the published version of a dashboard.
|
UpdateDataSetResult |
updateDataSet(UpdateDataSetRequest request)
Updates a dataset.
|
UpdateDataSetPermissionsResult |
updateDataSetPermissions(UpdateDataSetPermissionsRequest request)
Updates the permissions on a dataset.
|
UpdateDataSourceResult |
updateDataSource(UpdateDataSourceRequest request)
Updates a data source.
|
UpdateDataSourcePermissionsResult |
updateDataSourcePermissions(UpdateDataSourcePermissionsRequest request)
Updates the permissions to a data source.
|
UpdateGroupResult |
updateGroup(UpdateGroupRequest request)
Changes a group description.
|
UpdateIAMPolicyAssignmentResult |
updateIAMPolicyAssignment(UpdateIAMPolicyAssignmentRequest request)
Updates an existing IAM policy assignment.
|
UpdateTemplateResult |
updateTemplate(UpdateTemplateRequest request)
Updates a template from an existing Amazon QuickSight analysis or another template.
|
UpdateTemplateAliasResult |
updateTemplateAlias(UpdateTemplateAliasRequest request)
Updates the template alias of a template.
|
UpdateTemplatePermissionsResult |
updateTemplatePermissions(UpdateTemplatePermissionsRequest request)
Updates the resource permissions for a template.
|
UpdateUserResult |
updateUser(UpdateUserRequest request)
Updates an Amazon QuickSight user.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
shutdown
public static AmazonQuickSightClientBuilder builder()
public CancelIngestionResult cancelIngestion(CancelIngestionRequest request)
Cancels an ongoing ingestion of data into SPICE.
cancelIngestion
in interface AmazonQuickSight
cancelIngestionRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidParameterValueException
- 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.public CreateDashboardResult createDashboard(CreateDashboardRequest request)
Creates a dashboard from a template. To first create a template, see the CreateTemplate API 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. The
CreateDashboard
, DescribeDashboard
, and ListDashboardsByUser
API
operations 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.
createDashboard
in interface AmazonQuickSight
createDashboardRequest
- 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.public CreateDataSetResult createDataSet(CreateDataSetRequest request)
Creates a dataset.
createDataSet
in interface AmazonQuickSight
createDataSetRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.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.public CreateDataSourceResult createDataSource(CreateDataSourceRequest request)
Creates a data source.
createDataSource
in interface AmazonQuickSight
createDataSourceRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.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.public CreateGroupResult createGroup(CreateGroupRequest request)
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.
createGroup
in interface AmazonQuickSight
createGroupRequest
- The request object for this operation.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.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.public CreateGroupMembershipResult createGroupMembership(CreateGroupMembershipRequest request)
Adds an Amazon QuickSight user to an Amazon QuickSight group.
createGroupMembership
in interface AmazonQuickSight
createGroupMembershipRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidParameterValueException
- 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.public CreateIAMPolicyAssignmentResult createIAMPolicyAssignment(CreateIAMPolicyAssignmentRequest request)
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy will be assigned to specified groups or users of Amazon QuickSight. The users and groups need to be in the same namespace.
createIAMPolicyAssignment
in interface AmazonQuickSight
createIAMPolicyAssignmentRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.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 action is happening that must complete before a new
update can be applied.InternalFailureException
- An internal failure occurred.public CreateIngestionResult createIngestion(CreateIngestionRequest request)
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.
createIngestion
in interface AmazonQuickSight
createIngestionRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidParameterValueException
- 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.public CreateTemplateResult createTemplate(CreateTemplateRequest request)
Creates a template from an existing QuickSight analysis or template. You can use the resulting template to create a dashboard.
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.
createTemplate
in interface AmazonQuickSight
createTemplateRequest
- 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
access keys.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.InternalFailureException
- An internal failure occurred.public CreateTemplateAliasResult createTemplateAlias(CreateTemplateAliasRequest request)
Creates a template alias for a template.
createTemplateAlias
in interface AmazonQuickSight
createTemplateAliasRequest
- 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.InternalFailureException
- An internal failure occurred.public DeleteDashboardResult deleteDashboard(DeleteDashboardRequest request)
Deletes a dashboard.
deleteDashboard
in interface AmazonQuickSight
deleteDashboardRequest
- 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.public DeleteDataSetResult deleteDataSet(DeleteDataSetRequest request)
Deletes a dataset.
deleteDataSet
in interface AmazonQuickSight
deleteDataSetRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.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.public DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest request)
Deletes the data source permanently. This action breaks all the datasets that reference the deleted data source.
deleteDataSource
in interface AmazonQuickSight
deleteDataSourceRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.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.public DeleteGroupResult deleteGroup(DeleteGroupRequest request)
Removes a user group from Amazon QuickSight.
deleteGroup
in interface AmazonQuickSight
deleteGroupRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidParameterValueException
- 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.public DeleteGroupMembershipResult deleteGroupMembership(DeleteGroupMembershipRequest request)
Removes a user from a group so that the user is no longer a member of the group.
deleteGroupMembership
in interface AmazonQuickSight
deleteGroupMembershipRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidParameterValueException
- 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.public DeleteIAMPolicyAssignmentResult deleteIAMPolicyAssignment(DeleteIAMPolicyAssignmentRequest request)
Deletes an existing IAM policy assignment.
deleteIAMPolicyAssignment
in interface AmazonQuickSight
deleteIAMPolicyAssignmentRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.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 action is happening that must complete before a new
update can be applied.InternalFailureException
- An internal failure occurred.public DeleteTemplateResult deleteTemplate(DeleteTemplateRequest request)
Deletes a template.
deleteTemplate
in interface AmazonQuickSight
deleteTemplateRequest
- InvalidParameterValueException
- 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.public DeleteTemplateAliasResult deleteTemplateAlias(DeleteTemplateAliasRequest request)
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.
deleteTemplateAlias
in interface AmazonQuickSight
deleteTemplateAliasRequest
- 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.public DeleteUserResult deleteUser(DeleteUserRequest request)
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.
deleteUser
in interface AmazonQuickSight
deleteUserRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidParameterValueException
- 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.public DeleteUserByPrincipalIdResult deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest request)
Deletes a user identified by its principal ID.
deleteUserByPrincipalId
in interface AmazonQuickSight
deleteUserByPrincipalIdRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidParameterValueException
- 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.public DescribeDashboardResult describeDashboard(DescribeDashboardRequest request)
Provides a summary for a dashboard.
describeDashboard
in interface AmazonQuickSight
describeDashboardRequest
- 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
access keys.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.public DescribeDashboardPermissionsResult describeDashboardPermissions(DescribeDashboardPermissionsRequest request)
Describes read and write permissions for a dashboard.
describeDashboardPermissions
in interface AmazonQuickSight
describeDashboardPermissionsRequest
- InvalidParameterValueException
- 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.public DescribeDataSetResult describeDataSet(DescribeDataSetRequest request)
Describes a dataset.
describeDataSet
in interface AmazonQuickSight
describeDataSetRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.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.public DescribeDataSetPermissionsResult describeDataSetPermissions(DescribeDataSetPermissionsRequest request)
Describes the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id
.
describeDataSetPermissions
in interface AmazonQuickSight
describeDataSetPermissionsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.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.public DescribeDataSourceResult describeDataSource(DescribeDataSourceRequest request)
Describes a data source.
describeDataSource
in interface AmazonQuickSight
describeDataSourceRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.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.public DescribeDataSourcePermissionsResult describeDataSourcePermissions(DescribeDataSourcePermissionsRequest request)
Describes the resource permissions for a data source.
describeDataSourcePermissions
in interface AmazonQuickSight
describeDataSourcePermissionsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.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.public DescribeGroupResult describeGroup(DescribeGroupRequest request)
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
describeGroup
in interface AmazonQuickSight
describeGroupRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidParameterValueException
- 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.public DescribeIAMPolicyAssignmentResult describeIAMPolicyAssignment(DescribeIAMPolicyAssignmentRequest request)
Describes an existing IAM policy assignment, as specified by the assignment name.
describeIAMPolicyAssignment
in interface AmazonQuickSight
describeIAMPolicyAssignmentRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.public DescribeIngestionResult describeIngestion(DescribeIngestionRequest request)
Describes a SPICE ingestion.
describeIngestion
in interface AmazonQuickSight
describeIngestionRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidParameterValueException
- 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.public DescribeTemplateResult describeTemplate(DescribeTemplateRequest request)
Describes a template's metadata.
describeTemplate
in interface AmazonQuickSight
describeTemplateRequest
- 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
access keys.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.public DescribeTemplateAliasResult describeTemplateAlias(DescribeTemplateAliasRequest request)
Describes the template alias for a template.
describeTemplateAlias
in interface AmazonQuickSight
describeTemplateAliasRequest
- 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.public DescribeTemplatePermissionsResult describeTemplatePermissions(DescribeTemplatePermissionsRequest request)
Describes read and write permissions on a template.
describeTemplatePermissions
in interface AmazonQuickSight
describeTemplatePermissionsRequest
- 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.public DescribeUserResult describeUser(DescribeUserRequest request)
Returns information about a user, given the user name.
describeUser
in interface AmazonQuickSight
describeUserRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidParameterValueException
- 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.public GetDashboardEmbedUrlResult getDashboardEmbedUrl(GetDashboardEmbedUrlRequest request)
Generates a server-side embeddable URL and authorization code. For this process to work properly, first configure the dashboards and user permissions. For more information, see Embedding Amazon QuickSight Dashboards in the Amazon QuickSight User Guide or Embedding Amazon QuickSight Dashboards in the Amazon QuickSight API Reference.
Currently, you can use GetDashboardEmbedURL
only from the server, not from the user’s browser.
getDashboardEmbedUrl
in interface AmazonQuickSight
getDashboardEmbedUrlRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.DomainNotWhitelistedException
- The domain specified isn't on the allow list. All domains for embedded dashboards must be added to the
approved list by an Amazon QuickSight admin.QuickSightUserNotFoundException
- The user with the provided name isn't found. This error can happen in any operation that requires finding
a user based on a provided user name, such as DeleteUser
, DescribeUser
, and so
on.IdentityTypeNotSupportedException
- The identity type specified isn't supported. Supported identity types include IAM
and
QUICKSIGHT
.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.public ListDashboardVersionsResult listDashboardVersions(ListDashboardVersionsRequest request)
Lists all the versions of the dashboards in the QuickSight subscription.
listDashboardVersions
in interface AmazonQuickSight
listDashboardVersionsRequest
- InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public ListDashboardsResult listDashboards(ListDashboardsRequest request)
Lists dashboards in an AWS account.
listDashboards
in interface AmazonQuickSight
listDashboardsRequest
- ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public ListDataSetsResult listDataSets(ListDataSetsRequest request)
Lists all of the datasets belonging to the current AWS account in an AWS Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*
.
listDataSets
in interface AmazonQuickSight
listDataSetsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.public ListDataSourcesResult listDataSources(ListDataSourcesRequest request)
Lists data sources in current AWS Region that belong to this AWS account.
listDataSources
in interface AmazonQuickSight
listDataSourcesRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.public ListGroupMembershipsResult listGroupMemberships(ListGroupMembershipsRequest request)
Lists member users in a group.
listGroupMemberships
in interface AmazonQuickSight
listGroupMembershipsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public ListGroupsResult listGroups(ListGroupsRequest request)
Lists all user groups in Amazon QuickSight.
listGroups
in interface AmazonQuickSight
listGroupsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public ListIAMPolicyAssignmentsResult listIAMPolicyAssignments(ListIAMPolicyAssignmentsRequest request)
Lists IAM policy assignments in the current Amazon QuickSight account.
listIAMPolicyAssignments
in interface AmazonQuickSight
listIAMPolicyAssignmentsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.public ListIAMPolicyAssignmentsForUserResult listIAMPolicyAssignmentsForUser(ListIAMPolicyAssignmentsForUserRequest request)
Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to.
listIAMPolicyAssignmentsForUser
in interface AmazonQuickSight
listIAMPolicyAssignmentsForUserRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.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 action is happening that must complete before a new
update can be applied.InternalFailureException
- An internal failure occurred.public ListIngestionsResult listIngestions(ListIngestionsRequest request)
Lists the history of SPICE ingestions for a dataset.
listIngestions
in interface AmazonQuickSight
listIngestionsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.ResourceExistsException
- The resource specified already exists.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists the tags assigned to a resource.
listTagsForResource
in interface AmazonQuickSight
listTagsForResourceRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidParameterValueException
- 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.public ListTemplateAliasesResult listTemplateAliases(ListTemplateAliasesRequest request)
Lists all the aliases of a template.
listTemplateAliases
in interface AmazonQuickSight
listTemplateAliasesRequest
- 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.public ListTemplateVersionsResult listTemplateVersions(ListTemplateVersionsRequest request)
Lists all the versions of the templates in the current Amazon QuickSight account.
listTemplateVersions
in interface AmazonQuickSight
listTemplateVersionsRequest
- ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public ListTemplatesResult listTemplates(ListTemplatesRequest request)
Lists all the templates in the current Amazon QuickSight account.
listTemplates
in interface AmazonQuickSight
listTemplatesRequest
- ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public ListUserGroupsResult listUserGroups(ListUserGroupsRequest request)
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
listUserGroups
in interface AmazonQuickSight
listUserGroupsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidParameterValueException
- 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.public ListUsersResult listUsers(ListUsersRequest request)
Returns a list of all of the Amazon QuickSight users belonging to this account.
listUsers
in interface AmazonQuickSight
listUsersRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public RegisterUserResult registerUser(RegisterUserRequest request)
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
registerUser
in interface AmazonQuickSight
registerUserRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidParameterValueException
- 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.public SearchDashboardsResult searchDashboards(SearchDashboardsRequest request)
Searchs for dashboards that belong to a user.
searchDashboards
in interface AmazonQuickSight
searchDashboardsRequest
- 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
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.public TagResourceResult tagResource(TagResourceRequest request)
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.
tagResource
in interface AmazonQuickSight
tagResourceRequest
- 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
access keys.InvalidParameterValueException
- 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.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes a tag or tags from a resource.
untagResource
in interface AmazonQuickSight
untagResourceRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidParameterValueException
- 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.public UpdateDashboardResult updateDashboard(UpdateDashboardRequest request)
Updates a dashboard in an AWS account.
updateDashboard
in interface AmazonQuickSight
updateDashboardRequest
- 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.public UpdateDashboardPermissionsResult updateDashboardPermissions(UpdateDashboardPermissionsRequest request)
Updates read and write permissions on a dashboard.
updateDashboardPermissions
in interface AmazonQuickSight
updateDashboardPermissionsRequest
- 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.InternalFailureException
- An internal failure occurred.public UpdateDashboardPublishedVersionResult updateDashboardPublishedVersion(UpdateDashboardPublishedVersionRequest request)
Updates the published version of a dashboard.
updateDashboardPublishedVersion
in interface AmazonQuickSight
updateDashboardPublishedVersionRequest
- 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.public UpdateDataSetResult updateDataSet(UpdateDataSetRequest request)
Updates a dataset.
updateDataSet
in interface AmazonQuickSight
updateDataSetRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.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.public UpdateDataSetPermissionsResult updateDataSetPermissions(UpdateDataSetPermissionsRequest request)
Updates the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id
.
updateDataSetPermissions
in interface AmazonQuickSight
updateDataSetPermissionsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.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.public UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest request)
Updates a data source.
updateDataSource
in interface AmazonQuickSight
updateDataSourceRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.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.public UpdateDataSourcePermissionsResult updateDataSourcePermissions(UpdateDataSourcePermissionsRequest request)
Updates the permissions to a data source.
updateDataSourcePermissions
in interface AmazonQuickSight
updateDataSourcePermissionsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.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.public UpdateGroupResult updateGroup(UpdateGroupRequest request)
Changes a group description.
updateGroup
in interface AmazonQuickSight
updateGroupRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidParameterValueException
- 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.public UpdateIAMPolicyAssignmentResult updateIAMPolicyAssignment(UpdateIAMPolicyAssignmentRequest request)
Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request.
updateIAMPolicyAssignment
in interface AmazonQuickSight
updateIAMPolicyAssignmentRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.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 action is happening that must complete before a new
update can be applied.InternalFailureException
- An internal failure occurred.public UpdateTemplateResult updateTemplate(UpdateTemplateRequest request)
Updates a template from an existing Amazon QuickSight analysis or another template.
updateTemplate
in interface AmazonQuickSight
updateTemplateRequest
- 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.public UpdateTemplateAliasResult updateTemplateAlias(UpdateTemplateAliasRequest request)
Updates the template alias of a template.
updateTemplateAlias
in interface AmazonQuickSight
updateTemplateAliasRequest
- 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.InternalFailureException
- An internal failure occurred.public UpdateTemplatePermissionsResult updateTemplatePermissions(UpdateTemplatePermissionsRequest request)
Updates the resource permissions for a template.
updateTemplatePermissions
in interface AmazonQuickSight
updateTemplatePermissionsRequest
- 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.public UpdateUserResult updateUser(UpdateUserRequest request)
Updates an Amazon QuickSight user.
updateUser
in interface AmazonQuickSight
updateUserRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidParameterValueException
- 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 the request.
getCachedResponseMetadata
in interface AmazonQuickSight
request
- The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.