@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonQuickSight
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonQuickSight instead.
Amazon QuickSight is a fully managed, serverless business intelligence service for the Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
CancelIngestionResult |
cancelIngestion(CancelIngestionRequest cancelIngestionRequest)
Cancels an ongoing ingestion of data into SPICE.
|
CreateAccountCustomizationResult |
createAccountCustomization(CreateAccountCustomizationRequest createAccountCustomizationRequest)
Creates Amazon QuickSight customizations the current Amazon Web Services Region;.
|
CreateAnalysisResult |
createAnalysis(CreateAnalysisRequest createAnalysisRequest)
Creates an analysis in Amazon QuickSight.
|
CreateDashboardResult |
createDashboard(CreateDashboardRequest createDashboardRequest)
Creates a dashboard from a template.
|
CreateDataSetResult |
createDataSet(CreateDataSetRequest createDataSetRequest)
Creates a dataset.
|
CreateDataSourceResult |
createDataSource(CreateDataSourceRequest createDataSourceRequest)
Creates a data source.
|
CreateFolderResult |
createFolder(CreateFolderRequest createFolderRequest)
Creates an empty shared folder.
|
CreateFolderMembershipResult |
createFolderMembership(CreateFolderMembershipRequest createFolderMembershipRequest)
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
|
CreateGroupResult |
createGroup(CreateGroupRequest createGroupRequest)
Creates an Amazon QuickSight group.
|
CreateGroupMembershipResult |
createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest)
Adds an Amazon QuickSight user to an Amazon QuickSight group.
|
CreateIAMPolicyAssignmentResult |
createIAMPolicyAssignment(CreateIAMPolicyAssignmentRequest createIAMPolicyAssignmentRequest)
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN).
|
CreateIngestionResult |
createIngestion(CreateIngestionRequest createIngestionRequest)
Creates and starts a new SPICE ingestion on a dataset
|
CreateNamespaceResult |
createNamespace(CreateNamespaceRequest createNamespaceRequest)
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
|
CreateTemplateResult |
createTemplate(CreateTemplateRequest createTemplateRequest)
Creates a template from an existing Amazon QuickSight analysis or template.
|
CreateTemplateAliasResult |
createTemplateAlias(CreateTemplateAliasRequest createTemplateAliasRequest)
Creates a template alias for a template.
|
CreateThemeResult |
createTheme(CreateThemeRequest createThemeRequest)
Creates a theme.
|
CreateThemeAliasResult |
createThemeAlias(CreateThemeAliasRequest createThemeAliasRequest)
Creates a theme alias for a theme.
|
DeleteAccountCustomizationResult |
deleteAccountCustomization(DeleteAccountCustomizationRequest deleteAccountCustomizationRequest)
Deletes all Amazon QuickSight customizations in this Amazon Web Services Region; for the specified Amazon Web
Services account; and QuickSight namespace.
|
DeleteAnalysisResult |
deleteAnalysis(DeleteAnalysisRequest deleteAnalysisRequest)
Deletes an analysis from Amazon QuickSight.
|
DeleteDashboardResult |
deleteDashboard(DeleteDashboardRequest deleteDashboardRequest)
Deletes a dashboard.
|
DeleteDataSetResult |
deleteDataSet(DeleteDataSetRequest deleteDataSetRequest)
Deletes a dataset.
|
DeleteDataSourceResult |
deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)
Deletes the data source permanently.
|
DeleteFolderResult |
deleteFolder(DeleteFolderRequest deleteFolderRequest)
Deletes an empty folder.
|
DeleteFolderMembershipResult |
deleteFolderMembership(DeleteFolderMembershipRequest deleteFolderMembershipRequest)
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
|
DeleteGroupResult |
deleteGroup(DeleteGroupRequest deleteGroupRequest)
Removes a user group from Amazon QuickSight.
|
DeleteGroupMembershipResult |
deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest)
Removes a user from a group so that the user is no longer a member of the group.
|
DeleteIAMPolicyAssignmentResult |
deleteIAMPolicyAssignment(DeleteIAMPolicyAssignmentRequest deleteIAMPolicyAssignmentRequest)
Deletes an existing IAM policy assignment.
|
DeleteNamespaceResult |
deleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest)
Deletes a namespace and the users and groups that are associated with the namespace.
|
DeleteTemplateResult |
deleteTemplate(DeleteTemplateRequest deleteTemplateRequest)
Deletes a template.
|
DeleteTemplateAliasResult |
deleteTemplateAlias(DeleteTemplateAliasRequest deleteTemplateAliasRequest)
Deletes the item that the specified template alias points to.
|
DeleteThemeResult |
deleteTheme(DeleteThemeRequest deleteThemeRequest)
Deletes a theme.
|
DeleteThemeAliasResult |
deleteThemeAlias(DeleteThemeAliasRequest deleteThemeAliasRequest)
Deletes the version of the theme that the specified theme alias points to.
|
DeleteUserResult |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes the Amazon QuickSight user that is associated with the identity of the Identity and Access Management
(IAM) user or role that's making the call.
|
DeleteUserByPrincipalIdResult |
deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest deleteUserByPrincipalIdRequest)
Deletes a user identified by its principal ID.
|
DescribeAccountCustomizationResult |
describeAccountCustomization(DescribeAccountCustomizationRequest describeAccountCustomizationRequest)
Describes the customizations associated with the provided Amazon Web Services account; and Amazon QuickSight
namespace in an Amazon Web Services Region;.
|
DescribeAccountSettingsResult |
describeAccountSettings(DescribeAccountSettingsRequest describeAccountSettingsRequest)
Describes the settings that were used when your QuickSight subscription was first created in this Amazon Web
Services account;.
|
DescribeAnalysisResult |
describeAnalysis(DescribeAnalysisRequest describeAnalysisRequest)
Provides a summary of the metadata for an analysis.
|
DescribeAnalysisPermissionsResult |
describeAnalysisPermissions(DescribeAnalysisPermissionsRequest describeAnalysisPermissionsRequest)
Provides the read and write permissions for an analysis.
|
DescribeDashboardResult |
describeDashboard(DescribeDashboardRequest describeDashboardRequest)
Provides a summary for a dashboard.
|
DescribeDashboardPermissionsResult |
describeDashboardPermissions(DescribeDashboardPermissionsRequest describeDashboardPermissionsRequest)
Describes read and write permissions for a dashboard.
|
DescribeDataSetResult |
describeDataSet(DescribeDataSetRequest describeDataSetRequest)
Describes a dataset.
|
DescribeDataSetPermissionsResult |
describeDataSetPermissions(DescribeDataSetPermissionsRequest describeDataSetPermissionsRequest)
Describes the permissions on a dataset.
|
DescribeDataSourceResult |
describeDataSource(DescribeDataSourceRequest describeDataSourceRequest)
Describes a data source.
|
DescribeDataSourcePermissionsResult |
describeDataSourcePermissions(DescribeDataSourcePermissionsRequest describeDataSourcePermissionsRequest)
Describes the resource permissions for a data source.
|
DescribeFolderResult |
describeFolder(DescribeFolderRequest describeFolderRequest)
Describes a folder.
|
DescribeFolderPermissionsResult |
describeFolderPermissions(DescribeFolderPermissionsRequest describeFolderPermissionsRequest)
Describes permissions for a folder.
|
DescribeFolderResolvedPermissionsResult |
describeFolderResolvedPermissions(DescribeFolderResolvedPermissionsRequest describeFolderResolvedPermissionsRequest)
Describes the folder resolved permissions.
|
DescribeGroupResult |
describeGroup(DescribeGroupRequest describeGroupRequest)
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
|
DescribeIAMPolicyAssignmentResult |
describeIAMPolicyAssignment(DescribeIAMPolicyAssignmentRequest describeIAMPolicyAssignmentRequest)
Describes an existing IAM policy assignment, as specified by the assignment name.
|
DescribeIngestionResult |
describeIngestion(DescribeIngestionRequest describeIngestionRequest)
Describes a SPICE ingestion.
|
DescribeNamespaceResult |
describeNamespace(DescribeNamespaceRequest describeNamespaceRequest)
Describes the current namespace.
|
DescribeTemplateResult |
describeTemplate(DescribeTemplateRequest describeTemplateRequest)
Describes a template's metadata.
|
DescribeTemplateAliasResult |
describeTemplateAlias(DescribeTemplateAliasRequest describeTemplateAliasRequest)
Describes the template alias for a template.
|
DescribeTemplatePermissionsResult |
describeTemplatePermissions(DescribeTemplatePermissionsRequest describeTemplatePermissionsRequest)
Describes read and write permissions on a template.
|
DescribeThemeResult |
describeTheme(DescribeThemeRequest describeThemeRequest)
Describes a theme.
|
DescribeThemeAliasResult |
describeThemeAlias(DescribeThemeAliasRequest describeThemeAliasRequest)
Describes the alias for a theme.
|
DescribeThemePermissionsResult |
describeThemePermissions(DescribeThemePermissionsRequest describeThemePermissionsRequest)
Describes the read and write permissions for a theme.
|
DescribeUserResult |
describeUser(DescribeUserRequest describeUserRequest)
Returns information about a user, given the user name.
|
GenerateEmbedUrlForAnonymousUserResult |
generateEmbedUrlForAnonymousUser(GenerateEmbedUrlForAnonymousUserRequest generateEmbedUrlForAnonymousUserRequest)
Generates an embed URL that you can use to embed an Amazon QuickSight dashboard in your website, without having
to register any reader users.
|
GenerateEmbedUrlForRegisteredUserResult |
generateEmbedUrlForRegisteredUser(GenerateEmbedUrlForRegisteredUserRequest generateEmbedUrlForRegisteredUserRequest)
Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website.
|
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 getDashboardEmbedUrlRequest)
Generates a session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard
in your web server code.
|
GetSessionEmbedUrlResult |
getSessionEmbedUrl(GetSessionEmbedUrlRequest getSessionEmbedUrlRequest)
Generates a session URL and authorization code that you can use to embed the Amazon QuickSight console in your
web server code.
|
ListAnalysesResult |
listAnalyses(ListAnalysesRequest listAnalysesRequest)
Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account;.
|
ListDashboardsResult |
listDashboards(ListDashboardsRequest listDashboardsRequest)
Lists dashboards in an Amazon Web Services account;.
|
ListDashboardVersionsResult |
listDashboardVersions(ListDashboardVersionsRequest listDashboardVersionsRequest)
Lists all the versions of the dashboards in the QuickSight subscription.
|
ListDataSetsResult |
listDataSets(ListDataSetsRequest listDataSetsRequest)
Lists all of the datasets belonging to the current Amazon Web Services account; in an Amazon Web Services
Region;.
|
ListDataSourcesResult |
listDataSources(ListDataSourcesRequest listDataSourcesRequest)
Lists data sources in current Amazon Web Services Region; that belong to this Amazon Web Services account;.
|
ListFolderMembersResult |
listFolderMembers(ListFolderMembersRequest listFolderMembersRequest)
List all assets (
DASHBOARD, ANALYSIS, and DATASET) in a folder. |
ListFoldersResult |
listFolders(ListFoldersRequest listFoldersRequest)
Lists all folders in an account.
|
ListGroupMembershipsResult |
listGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest)
Lists member users in a group.
|
ListGroupsResult |
listGroups(ListGroupsRequest listGroupsRequest)
Lists all user groups in Amazon QuickSight.
|
ListIAMPolicyAssignmentsResult |
listIAMPolicyAssignments(ListIAMPolicyAssignmentsRequest listIAMPolicyAssignmentsRequest)
Lists IAM policy assignments in the current Amazon QuickSight account.
|
ListIAMPolicyAssignmentsForUserResult |
listIAMPolicyAssignmentsForUser(ListIAMPolicyAssignmentsForUserRequest listIAMPolicyAssignmentsForUserRequest)
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 listIngestionsRequest)
Lists the history of SPICE ingestions for a dataset.
|
ListNamespacesResult |
listNamespaces(ListNamespacesRequest listNamespacesRequest)
Lists the namespaces for the specified Amazon Web Services account;.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags assigned to a resource.
|
ListTemplateAliasesResult |
listTemplateAliases(ListTemplateAliasesRequest listTemplateAliasesRequest)
Lists all the aliases of a template.
|
ListTemplatesResult |
listTemplates(ListTemplatesRequest listTemplatesRequest)
Lists all the templates in the current Amazon QuickSight account.
|
ListTemplateVersionsResult |
listTemplateVersions(ListTemplateVersionsRequest listTemplateVersionsRequest)
Lists all the versions of the templates in the current Amazon QuickSight account.
|
ListThemeAliasesResult |
listThemeAliases(ListThemeAliasesRequest listThemeAliasesRequest)
Lists all the aliases of a theme.
|
ListThemesResult |
listThemes(ListThemesRequest listThemesRequest)
Lists all the themes in the current Amazon Web Services account;.
|
ListThemeVersionsResult |
listThemeVersions(ListThemeVersionsRequest listThemeVersionsRequest)
Lists all the versions of the themes in the current Amazon Web Services account;.
|
ListUserGroupsResult |
listUserGroups(ListUserGroupsRequest listUserGroupsRequest)
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
|
ListUsersResult |
listUsers(ListUsersRequest listUsersRequest)
Returns a list of all of the Amazon QuickSight users belonging to this account.
|
RegisterUserResult |
registerUser(RegisterUserRequest registerUserRequest)
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM)
identity or role specified in the request.
|
RestoreAnalysisResult |
restoreAnalysis(RestoreAnalysisRequest restoreAnalysisRequest)
Restores an analysis.
|
SearchAnalysesResult |
searchAnalyses(SearchAnalysesRequest searchAnalysesRequest)
Searches for analyses that belong to the user specified in the filter.
|
SearchDashboardsResult |
searchDashboards(SearchDashboardsRequest searchDashboardsRequest)
Searches for dashboards that belong to a user.
|
SearchFoldersResult |
searchFolders(SearchFoldersRequest searchFoldersRequest)
Searches the subfolders in a folder.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified QuickSight resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag or tags from a resource.
|
UpdateAccountCustomizationResult |
updateAccountCustomization(UpdateAccountCustomizationRequest updateAccountCustomizationRequest)
Updates Amazon QuickSight customizations the current Amazon Web Services Region;.
|
UpdateAccountSettingsResult |
updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest)
Updates the Amazon QuickSight settings in your Amazon Web Services account;.
|
UpdateAnalysisResult |
updateAnalysis(UpdateAnalysisRequest updateAnalysisRequest)
Updates an analysis in Amazon QuickSight
|
UpdateAnalysisPermissionsResult |
updateAnalysisPermissions(UpdateAnalysisPermissionsRequest updateAnalysisPermissionsRequest)
Updates the read and write permissions for an analysis.
|
UpdateDashboardResult |
updateDashboard(UpdateDashboardRequest updateDashboardRequest)
Updates a dashboard in an Amazon Web Services account;.
|
UpdateDashboardPermissionsResult |
updateDashboardPermissions(UpdateDashboardPermissionsRequest updateDashboardPermissionsRequest)
Updates read and write permissions on a dashboard.
|
UpdateDashboardPublishedVersionResult |
updateDashboardPublishedVersion(UpdateDashboardPublishedVersionRequest updateDashboardPublishedVersionRequest)
Updates the published version of a dashboard.
|
UpdateDataSetResult |
updateDataSet(UpdateDataSetRequest updateDataSetRequest)
Updates a dataset.
|
UpdateDataSetPermissionsResult |
updateDataSetPermissions(UpdateDataSetPermissionsRequest updateDataSetPermissionsRequest)
Updates the permissions on a dataset.
|
UpdateDataSourceResult |
updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)
Updates a data source.
|
UpdateDataSourcePermissionsResult |
updateDataSourcePermissions(UpdateDataSourcePermissionsRequest updateDataSourcePermissionsRequest)
Updates the permissions to a data source.
|
UpdateFolderResult |
updateFolder(UpdateFolderRequest updateFolderRequest)
Updates the name of a folder.
|
UpdateFolderPermissionsResult |
updateFolderPermissions(UpdateFolderPermissionsRequest updateFolderPermissionsRequest)
Updates permissions of a folder.
|
UpdateGroupResult |
updateGroup(UpdateGroupRequest updateGroupRequest)
Changes a group description.
|
UpdateIAMPolicyAssignmentResult |
updateIAMPolicyAssignment(UpdateIAMPolicyAssignmentRequest updateIAMPolicyAssignmentRequest)
Updates an existing IAM policy assignment.
|
UpdateTemplateResult |
updateTemplate(UpdateTemplateRequest updateTemplateRequest)
Updates a template from an existing Amazon QuickSight analysis or another template.
|
UpdateTemplateAliasResult |
updateTemplateAlias(UpdateTemplateAliasRequest updateTemplateAliasRequest)
Updates the template alias of a template.
|
UpdateTemplatePermissionsResult |
updateTemplatePermissions(UpdateTemplatePermissionsRequest updateTemplatePermissionsRequest)
Updates the resource permissions for a template.
|
UpdateThemeResult |
updateTheme(UpdateThemeRequest updateThemeRequest)
Updates a theme.
|
UpdateThemeAliasResult |
updateThemeAlias(UpdateThemeAliasRequest updateThemeAliasRequest)
Updates an alias of a theme.
|
UpdateThemePermissionsResult |
updateThemePermissions(UpdateThemePermissionsRequest updateThemePermissionsRequest)
Updates the resource permissions for a theme.
|
UpdateUserResult |
updateUser(UpdateUserRequest updateUserRequest)
Updates an Amazon QuickSight user.
|
static final String ENDPOINT_PREFIX
CancelIngestionResult cancelIngestion(CancelIngestionRequest cancelIngestionRequest)
Cancels an ongoing ingestion of data into SPICE.
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.CreateAccountCustomizationResult createAccountCustomization(CreateAccountCustomizationRequest createAccountCustomizationRequest)
Creates Amazon QuickSight customizations the current Amazon Web Services Region;. Currently, you can add a custom
default theme by using the CreateAccountCustomization or UpdateAccountCustomization API
operation. To further customize QuickSight by removing QuickSight sample assets and videos for all new users, see
Customizing
QuickSight in the Amazon QuickSight User Guide.
You can create customizations for your Amazon Web Services account; or, if you specify a namespace, for a
QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply
to an Amazon Web Services account;. To find out which customizations apply, use the
DescribeAccountCustomization API operation.
Before you use the CreateAccountCustomization API operation to add a theme as the namespace default,
make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme
isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the
current permissions by using the DescribeThemePermissions API operation. To share the
theme, grant permissions by using the UpdateThemePermissions API operation.
createAccountCustomizationRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.CreateAnalysisResult createAnalysis(CreateAnalysisRequest createAnalysisRequest)
Creates an analysis in Amazon QuickSight.
createAnalysisRequest - 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.CreateDashboardResult createDashboard(CreateDashboardRequest createDashboardRequest)
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. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account;.
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.CreateDataSetResult createDataSet(CreateDataSetRequest createDataSetRequest)
Creates a dataset.
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.CreateDataSourceResult createDataSource(CreateDataSourceRequest createDataSourceRequest)
Creates a data source.
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.CreateFolderResult createFolder(CreateFolderRequest createFolderRequest)
Creates an empty shared folder.
createFolderRequest - ResourceNotFoundException - One or more resources can't be found.InvalidParameterValueException - One or more parameters has a value that isn't valid.ThrottlingException - Access is throttled.ResourceExistsException - The resource specified already exists.ConflictException - Updating or deleting a resource can cause an inconsistent state.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.LimitExceededException - A limit is exceeded.InternalFailureException - An internal failure occurred.CreateFolderMembershipResult createFolderMembership(CreateFolderMembershipRequest createFolderMembershipRequest)
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
createFolderMembershipRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.ResourceExistsException - The resource specified already exists.ThrottlingException - Access is throttled.LimitExceededException - A limit is exceeded.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.CreateGroupResult createGroup(CreateGroupRequest createGroupRequest)
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.
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.CreateGroupMembershipResult createGroupMembership(CreateGroupMembershipRequest createGroupMembershipRequest)
Adds an Amazon QuickSight user to an Amazon QuickSight group.
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.CreateIAMPolicyAssignmentResult createIAMPolicyAssignment(CreateIAMPolicyAssignmentRequest createIAMPolicyAssignmentRequest)
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per Amazon Web Services account;. To avoid overwriting rules in other namespaces, use assignment names that are unique.
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 operation is happening that must complete before a new
update can be applied.InternalFailureException - An internal failure occurred.CreateIngestionResult createIngestion(CreateIngestionRequest createIngestionRequest)
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 Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
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.CreateNamespaceResult createNamespace(CreateNamespaceRequest createNamespaceRequest)
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
A namespace allows you to isolate the QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account; is subscribed to QuickSight. The namespace must be unique within the Amazon Web Services account;. By default, there is a limit of 100 namespaces per Amazon Web Services account;. To increase your limit, create a ticket with Amazon Web Services Support.
createNamespaceRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.ConflictException - Updating or deleting a resource can cause an inconsistent state.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.CreateTemplateResult createTemplate(CreateTemplateRequest createTemplateRequest)
Creates a template from an existing Amazon 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.
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.ConflictException - Updating or deleting a resource can cause an inconsistent state.InternalFailureException - An internal failure occurred.CreateTemplateAliasResult createTemplateAlias(CreateTemplateAliasRequest createTemplateAliasRequest)
Creates a template alias for a template.
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.ConflictException - Updating or deleting a resource can cause an inconsistent state.InternalFailureException - An internal failure occurred.CreateThemeResult createTheme(CreateThemeRequest createThemeRequest)
Creates a theme.
A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.
createThemeRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.LimitExceededException - A limit is exceeded.InternalFailureException - An internal failure occurred.CreateThemeAliasResult createThemeAlias(CreateThemeAliasRequest createThemeAliasRequest)
Creates a theme alias for a theme.
createThemeAliasRequest - 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.DeleteAccountCustomizationResult deleteAccountCustomization(DeleteAccountCustomizationRequest deleteAccountCustomizationRequest)
Deletes all Amazon QuickSight customizations in this Amazon Web Services Region; for the specified Amazon Web Services account; and QuickSight namespace.
deleteAccountCustomizationRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.DeleteAnalysisResult deleteAnalysis(DeleteAnalysisRequest deleteAnalysisRequest)
Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can
restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. QuickSight
attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the
end of the recovery window, QuickSight deletes the analysis permanently.
At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the
DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API
until it's deleted, so you can describe it but you can't make a template from it.
An analysis that's scheduled for deletion isn't accessible in the QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
deleteAnalysisRequest - 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.DeleteDashboardResult deleteDashboard(DeleteDashboardRequest deleteDashboardRequest)
Deletes a dashboard.
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.DeleteDataSetResult deleteDataSet(DeleteDataSetRequest deleteDataSetRequest)
Deletes a dataset.
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.DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)
Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
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.DeleteFolderResult deleteFolder(DeleteFolderRequest deleteFolderRequest)
Deletes an empty folder.
deleteFolderRequest - InvalidParameterValueException - One or more parameters has a value that isn't valid.PreconditionNotMetException - One or more preconditions aren't met.AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.ResourceNotFoundException - One or more resources can't be found.ConflictException - Updating or deleting a resource can cause an inconsistent state.ThrottlingException - Access is throttled.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.DeleteFolderMembershipResult deleteFolderMembership(DeleteFolderMembershipRequest deleteFolderMembershipRequest)
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
deleteFolderMembershipRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't 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.DeleteGroupResult deleteGroup(DeleteGroupRequest deleteGroupRequest)
Removes a user group from Amazon QuickSight.
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.DeleteGroupMembershipResult deleteGroupMembership(DeleteGroupMembershipRequest deleteGroupMembershipRequest)
Removes a user from a group so that the user is no longer a member of the group.
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.DeleteIAMPolicyAssignmentResult deleteIAMPolicyAssignment(DeleteIAMPolicyAssignmentRequest deleteIAMPolicyAssignmentRequest)
Deletes an existing IAM policy assignment.
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 operation is happening that must complete before a new
update can be applied.InternalFailureException - An internal failure occurred.DeleteNamespaceResult deleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest)
Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.
deleteNamespaceRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.DeleteTemplateResult deleteTemplate(DeleteTemplateRequest deleteTemplateRequest)
Deletes a template.
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.DeleteTemplateAliasResult deleteTemplateAlias(DeleteTemplateAliasRequest deleteTemplateAliasRequest)
Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
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.ConflictException - Updating or deleting a resource can cause an inconsistent state.InternalFailureException - An internal failure occurred.DeleteThemeResult deleteTheme(DeleteThemeRequest deleteThemeRequest)
Deletes a theme.
deleteThemeRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't 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.DeleteThemeAliasResult deleteThemeAlias(DeleteThemeAliasRequest deleteThemeAliasRequest)
Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.
deleteThemeAliasRequest - ConflictException - Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)
Deletes the Amazon QuickSight user that is associated with the identity of the 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.
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.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.DeleteUserByPrincipalIdResult deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest deleteUserByPrincipalIdRequest)
Deletes a user identified by its principal ID.
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.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.DescribeAccountCustomizationResult describeAccountCustomization(DescribeAccountCustomizationRequest describeAccountCustomizationRequest)
Describes the customizations associated with the provided Amazon Web Services account; and Amazon QuickSight
namespace in an Amazon Web Services Region;. The QuickSight console evaluates which customizations to apply by
running this API operation with the Resolved flag included.
To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.
Amazon Web Services account; - The Amazon Web Services account; exists at the top of the hierarchy.
It has the potential to use all of the Amazon Web Services Regions; and AWS Services. When you subscribe to
QuickSight, you choose one Amazon Web Services Region; to use as your home Region. That's where your free SPICE
capacity is located. You can use QuickSight in any supported Amazon Web Services Region;.
Amazon Web Services Region; - In each Amazon Web Services Region; where you sign in to QuickSight at
least once, QuickSight acts as a separate instance of the same service. If you have a user directory, it resides
in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to QuickSight in
any Amazon Web Services Region;, unless they are constrained to a namespace.
To run the command in a different Amazon Web Services Region;, you change your Region settings. If you're using the AWS CLI, you can use one of the following options:
Use command line options.
Use named profiles.
Run aws configure to change your default Amazon Web Services Region;. Use Enter to key the same
settings for your keys. For more information, see Configuring the AWS CLI.
Namespace - A QuickSight namespace is a partition that contains users and assets (data sources,
datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also
be part of the same namespace. People who share a namespace are completely isolated from users and assets in
other namespaces, even if they are in the same Amazon Web Services account; and Amazon Web Services Region;.
Applied customizations - Within an Amazon Web Services Region;, a set of QuickSight customizations
can apply to an Amazon Web Services account; or to a namespace. Settings that you apply to a namespace override
settings that you apply to an Amazon Web Services account;. All settings are isolated to a single Amazon Web
Services Region;. To apply them in other Amazon Web Services Regions;, run the
CreateAccountCustomization command in each Amazon Web Services Region; where you want to apply the
same customizations.
describeAccountCustomizationRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.DescribeAccountSettingsResult describeAccountSettings(DescribeAccountSettingsRequest describeAccountSettingsRequest)
Describes the settings that were used when your QuickSight subscription was first created in this Amazon Web Services account;.
describeAccountSettingsRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.DescribeAnalysisResult describeAnalysis(DescribeAnalysisRequest describeAnalysisRequest)
Provides a summary of the metadata for an analysis.
describeAnalysisRequest - 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.DescribeAnalysisPermissionsResult describeAnalysisPermissions(DescribeAnalysisPermissionsRequest describeAnalysisPermissionsRequest)
Provides the read and write permissions for an analysis.
describeAnalysisPermissionsRequest - InvalidParameterValueException - 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.DescribeDashboardResult describeDashboard(DescribeDashboardRequest describeDashboardRequest)
Provides a summary for a dashboard.
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.DescribeDashboardPermissionsResult describeDashboardPermissions(DescribeDashboardPermissionsRequest describeDashboardPermissionsRequest)
Describes read and write permissions for a dashboard.
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.DescribeDataSetResult describeDataSet(DescribeDataSetRequest describeDataSetRequest)
Describes a dataset.
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.DescribeDataSetPermissionsResult describeDataSetPermissions(DescribeDataSetPermissionsRequest describeDataSetPermissionsRequest)
Describes the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
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.DescribeDataSourceResult describeDataSource(DescribeDataSourceRequest describeDataSourceRequest)
Describes a data source.
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.DescribeDataSourcePermissionsResult describeDataSourcePermissions(DescribeDataSourcePermissionsRequest describeDataSourcePermissionsRequest)
Describes the resource permissions for a data source.
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.DescribeFolderResult describeFolder(DescribeFolderRequest describeFolderRequest)
Describes a folder.
describeFolderRequest - 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.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.DescribeFolderPermissionsResult describeFolderPermissions(DescribeFolderPermissionsRequest describeFolderPermissionsRequest)
Describes permissions for a folder.
describeFolderPermissionsRequest - 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.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.DescribeFolderResolvedPermissionsResult describeFolderResolvedPermissions(DescribeFolderResolvedPermissionsRequest describeFolderResolvedPermissionsRequest)
Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
describeFolderResolvedPermissionsRequest - 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.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.DescribeGroupResult describeGroup(DescribeGroupRequest describeGroupRequest)
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
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.DescribeIAMPolicyAssignmentResult describeIAMPolicyAssignment(DescribeIAMPolicyAssignmentRequest describeIAMPolicyAssignmentRequest)
Describes an existing IAM policy assignment, as specified by the assignment name.
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.DescribeIngestionResult describeIngestion(DescribeIngestionRequest describeIngestionRequest)
Describes a SPICE ingestion.
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.DescribeNamespaceResult describeNamespace(DescribeNamespaceRequest describeNamespaceRequest)
Describes the current namespace.
describeNamespaceRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.DescribeTemplateResult describeTemplate(DescribeTemplateRequest describeTemplateRequest)
Describes a template's metadata.
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.DescribeTemplateAliasResult describeTemplateAlias(DescribeTemplateAliasRequest describeTemplateAliasRequest)
Describes the template alias for a template.
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.DescribeTemplatePermissionsResult describeTemplatePermissions(DescribeTemplatePermissionsRequest describeTemplatePermissionsRequest)
Describes read and write permissions on a template.
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.DescribeThemeResult describeTheme(DescribeThemeRequest describeThemeRequest)
Describes a theme.
describeThemeRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't 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.DescribeThemeAliasResult describeThemeAlias(DescribeThemeAliasRequest describeThemeAliasRequest)
Describes the alias for a theme.
describeThemeAliasRequest - ConflictException - Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.DescribeThemePermissionsResult describeThemePermissions(DescribeThemePermissionsRequest describeThemePermissionsRequest)
Describes the read and write permissions for a theme.
describeThemePermissionsRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't 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.DescribeUserResult describeUser(DescribeUserRequest describeUserRequest)
Returns information about a user, given the user name.
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.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.GenerateEmbedUrlForAnonymousUserResult generateEmbedUrlForAnonymousUser(GenerateEmbedUrlForAnonymousUserRequest generateEmbedUrlForAnonymousUserRequest)
Generates an embed URL that you can use to embed an Amazon QuickSight dashboard in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutes
parameter.
The resulting user session is valid for 15 minutes (default) to 10 hours (maximum).
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
generateEmbedUrlForAnonymousUserRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.SessionLifetimeInMinutesInvalidException - The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be
15-600 minutes.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.UnsupportedPricingPlanException - This error indicates that you are calling an embedding operation in Amazon QuickSight without the
required pricing plan on your Amazon Web Services account;. Before you can use embedding for anonymous
users, a QuickSight administrator needs to add capacity pricing to QuickSight. You can do this on the
Manage QuickSight page.
After capacity pricing is added, you can use the GetDashboardEmbedUrl API operation with the
--identity-type ANONYMOUS option.
InternalFailureException - An internal failure occurred.GenerateEmbedUrlForRegisteredUserResult generateEmbedUrlForRegisteredUser(GenerateEmbedUrlForRegisteredUserRequest generateEmbedUrlForRegisteredUserRequest)
Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutes
parameter.
The resulting user session is valid for 15 minutes (default) to 10 hours (maximum).
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
generateEmbedUrlForRegisteredUserRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.QuickSightUserNotFoundException - The user with the provided name isn't found. This error can happen in any operation that requires finding
a user based on a provided user name, such as DeleteUser, DescribeUser, and so
on.ResourceNotFoundException - One or more resources can't be found.SessionLifetimeInMinutesInvalidException - The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be
15-600 minutes.ThrottlingException - Access is throttled.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.UnsupportedPricingPlanException - This error indicates that you are calling an embedding operation in Amazon QuickSight without the
required pricing plan on your Amazon Web Services account;. Before you can use embedding for anonymous
users, a QuickSight administrator needs to add capacity pricing to QuickSight. You can do this on the
Manage QuickSight page.
After capacity pricing is added, you can use the GetDashboardEmbedUrl API operation with the
--identity-type ANONYMOUS option.
InternalFailureException - An internal failure occurred.GetDashboardEmbedUrlResult getDashboardEmbedUrl(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest)
Generates a session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions.
Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The
following rules apply to the combination of URL and authorization code:
They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
The resulting user session is valid for 10 hours.
For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
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.UnsupportedPricingPlanException - This error indicates that you are calling an embedding operation in Amazon QuickSight without the
required pricing plan on your Amazon Web Services account;. Before you can use embedding for anonymous
users, a QuickSight administrator needs to add capacity pricing to QuickSight. You can do this on the
Manage QuickSight page.
After capacity pricing is added, you can use the GetDashboardEmbedUrl API operation with the
--identity-type ANONYMOUS option.
InternalFailureException - An internal failure occurred.GetSessionEmbedUrlResult getSessionEmbedUrl(GetSessionEmbedUrlRequest getSessionEmbedUrlRequest)
Generates a session URL and authorization code that you can use to embed the Amazon QuickSight console in your
web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that allows
users to create data sources, datasets, analyses, and dashboards. The users who access an embedded QuickSight
console need belong to the author or admin security cohort. If you want to restrict permissions to some of these
features, add a custom permissions profile to the user with the UpdateUser API operation.
Use RegisterUser API operation to add a new user with a custom permission profile attached.
For more information, see the following sections in the Amazon QuickSight User Guide:
getSessionEmbedUrlRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.QuickSightUserNotFoundException - The user with the provided name isn't found. This error can happen in any operation that requires finding
a user based on a provided user name, such as DeleteUser, DescribeUser, and so
on.SessionLifetimeInMinutesInvalidException - The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be
15-600 minutes.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.ListAnalysesResult listAnalyses(ListAnalysesRequest listAnalysesRequest)
Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account;.
listAnalysesRequest - 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.ListDashboardVersionsResult listDashboardVersions(ListDashboardVersionsRequest listDashboardVersionsRequest)
Lists all the versions of the dashboards in the QuickSight subscription.
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.ListDashboardsResult listDashboards(ListDashboardsRequest listDashboardsRequest)
Lists dashboards in an Amazon Web Services account;.
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.ListDataSetsResult listDataSets(ListDataSetsRequest listDataSetsRequest)
Lists all of the datasets belonging to the current Amazon Web Services account; in an Amazon Web Services Region;.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
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.ListDataSourcesResult listDataSources(ListDataSourcesRequest listDataSourcesRequest)
Lists data sources in current Amazon Web Services Region; that belong to this Amazon Web Services account;.
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.ListFolderMembersResult listFolderMembers(ListFolderMembersRequest listFolderMembersRequest)
List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.
listFolderMembersRequest - 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.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.ListFoldersResult listFolders(ListFoldersRequest listFoldersRequest)
Lists all folders in an account.
listFoldersRequest - 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.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.ListGroupMembershipsResult listGroupMemberships(ListGroupMembershipsRequest listGroupMembershipsRequest)
Lists member users in a group.
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.ListGroupsResult listGroups(ListGroupsRequest listGroupsRequest)
Lists all user groups in Amazon QuickSight.
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.ListIAMPolicyAssignmentsResult listIAMPolicyAssignments(ListIAMPolicyAssignmentsRequest listIAMPolicyAssignmentsRequest)
Lists IAM policy assignments in the current Amazon QuickSight account.
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.ListIAMPolicyAssignmentsForUserResult listIAMPolicyAssignmentsForUser(ListIAMPolicyAssignmentsForUserRequest listIAMPolicyAssignmentsForUserRequest)
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.
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 operation is happening that must complete before a new
update can be applied.InternalFailureException - An internal failure occurred.ListIngestionsResult listIngestions(ListIngestionsRequest listIngestionsRequest)
Lists the history of SPICE ingestions for a dataset.
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.ListNamespacesResult listNamespaces(ListNamespacesRequest listNamespacesRequest)
Lists the namespaces for the specified Amazon Web Services account;.
listNamespacesRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags assigned to a resource.
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.ListTemplateAliasesResult listTemplateAliases(ListTemplateAliasesRequest listTemplateAliasesRequest)
Lists all the aliases of a template.
listTemplateAliasesRequest - InvalidNextTokenException - The NextToken value isn't valid.ThrottlingException - Access is throttled.ResourceNotFoundException - One or more resources can't be found.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.ListTemplateVersionsResult listTemplateVersions(ListTemplateVersionsRequest listTemplateVersionsRequest)
Lists all the versions of the templates in the current Amazon QuickSight account.
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.ListTemplatesResult listTemplates(ListTemplatesRequest listTemplatesRequest)
Lists all the templates in the current Amazon QuickSight account.
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.ListThemeAliasesResult listThemeAliases(ListThemeAliasesRequest listThemeAliasesRequest)
Lists all the aliases of a theme.
listThemeAliasesRequest - ConflictException - Updating or deleting a resource can cause an inconsistent state.InvalidNextTokenException - The NextToken value isn't valid.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.ListThemeVersionsResult listThemeVersions(ListThemeVersionsRequest listThemeVersionsRequest)
Lists all the versions of the themes in the current Amazon Web Services account;.
listThemeVersionsRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidNextTokenException - The NextToken value isn't valid.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.ListThemesResult listThemes(ListThemesRequest listThemesRequest)
Lists all the themes in the current Amazon Web Services account;.
listThemesRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.InvalidNextTokenException - The NextToken value isn't valid.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.ListUserGroupsResult listUserGroups(ListUserGroupsRequest listUserGroupsRequest)
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
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.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.ListUsersResult listUsers(ListUsersRequest listUsersRequest)
Returns a list of all of the Amazon QuickSight users belonging to this account.
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.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.RegisterUserResult registerUser(RegisterUserRequest registerUserRequest)
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
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.RestoreAnalysisResult restoreAnalysis(RestoreAnalysisRequest restoreAnalysisRequest)
Restores an analysis.
restoreAnalysisRequest - 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.SearchAnalysesResult searchAnalyses(SearchAnalysesRequest searchAnalysesRequest)
Searches for analyses that belong to the user specified in the filter.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
searchAnalysesRequest - 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.SearchDashboardsResult searchDashboards(SearchDashboardsRequest searchDashboardsRequest)
Searches for dashboards that belong to a user.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
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.SearchFoldersResult searchFolders(SearchFoldersRequest searchFoldersRequest)
Searches the subfolders in a folder.
searchFoldersRequest - 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.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.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
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 Resource Groups.
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.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag or tags from a resource.
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.UpdateAccountCustomizationResult updateAccountCustomization(UpdateAccountCustomizationRequest updateAccountCustomizationRequest)
Updates Amazon QuickSight customizations the current Amazon Web Services Region;. Currently, the only customization you can use is a theme.
You can use customizations for your Amazon Web Services account; or, if you specify a namespace, for a QuickSight
namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web
Services account;. To find out which customizations apply, use the DescribeAccountCustomization API
operation.
updateAccountCustomizationRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.UpdateAccountSettingsResult updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest)
Updates the Amazon QuickSight settings in your Amazon Web Services account;.
updateAccountSettingsRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.UpdateAnalysisResult updateAnalysis(UpdateAnalysisRequest updateAnalysisRequest)
Updates an analysis in Amazon QuickSight
updateAnalysisRequest - 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.UpdateAnalysisPermissionsResult updateAnalysisPermissions(UpdateAnalysisPermissionsRequest updateAnalysisPermissionsRequest)
Updates the read and write permissions for an analysis.
updateAnalysisPermissionsRequest - 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.UpdateDashboardResult updateDashboard(UpdateDashboardRequest updateDashboardRequest)
Updates a dashboard in an Amazon Web Services account;.
Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation.
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.UpdateDashboardPermissionsResult updateDashboardPermissions(UpdateDashboardPermissionsRequest updateDashboardPermissionsRequest)
Updates read and write permissions on a dashboard.
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.UpdateDashboardPublishedVersionResult updateDashboardPublishedVersion(UpdateDashboardPublishedVersionRequest updateDashboardPublishedVersionRequest)
Updates the published version of a dashboard.
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.UpdateDataSetResult updateDataSet(UpdateDataSetRequest updateDataSetRequest)
Updates a dataset.
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.UpdateDataSetPermissionsResult updateDataSetPermissions(UpdateDataSetPermissionsRequest updateDataSetPermissionsRequest)
Updates the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
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.UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)
Updates a data source.
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.UpdateDataSourcePermissionsResult updateDataSourcePermissions(UpdateDataSourcePermissionsRequest updateDataSourcePermissionsRequest)
Updates the permissions to a data source.
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.UpdateFolderResult updateFolder(UpdateFolderRequest updateFolderRequest)
Updates the name of a folder.
updateFolderRequest - 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.ConflictException - Updating or deleting a resource can cause an inconsistent state.ThrottlingException - Access is throttled.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.UpdateFolderPermissionsResult updateFolderPermissions(UpdateFolderPermissionsRequest updateFolderPermissionsRequest)
Updates permissions of a folder.
updateFolderPermissionsRequest - 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.LimitExceededException - A limit is exceeded.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.UpdateGroupResult updateGroup(UpdateGroupRequest updateGroupRequest)
Changes a group description.
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.UpdateIAMPolicyAssignmentResult updateIAMPolicyAssignment(UpdateIAMPolicyAssignmentRequest updateIAMPolicyAssignmentRequest)
Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that
are specified in the request. This overwrites all of the users included in Identities.
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 operation is happening that must complete before a new
update can be applied.InternalFailureException - An internal failure occurred.UpdateTemplateResult updateTemplate(UpdateTemplateRequest updateTemplateRequest)
Updates a template from an existing Amazon QuickSight analysis or another template.
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.UpdateTemplateAliasResult updateTemplateAlias(UpdateTemplateAliasRequest updateTemplateAliasRequest)
Updates the template alias of a template.
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.ConflictException - Updating or deleting a resource can cause an inconsistent state.InternalFailureException - An internal failure occurred.UpdateTemplatePermissionsResult updateTemplatePermissions(UpdateTemplatePermissionsRequest updateTemplatePermissionsRequest)
Updates the resource permissions for a template.
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.UpdateThemeResult updateTheme(UpdateThemeRequest updateThemeRequest)
Updates a theme.
updateThemeRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.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.UpdateThemeAliasResult updateThemeAlias(UpdateThemeAliasRequest updateThemeAliasRequest)
Updates an alias of a theme.
updateThemeAliasRequest - ConflictException - Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException - One or more parameters has a value that isn't valid.ResourceExistsException - The resource specified already exists.ResourceNotFoundException - One or more resources can't be found.ThrottlingException - Access is throttled.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and
Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException - An internal failure occurred.UpdateThemePermissionsResult updateThemePermissions(UpdateThemePermissionsRequest updateThemePermissionsRequest)
Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on,
for example "quicksight:DescribeTheme".
Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions:
User
"quicksight:DescribeTheme"
"quicksight:DescribeThemeAlias"
"quicksight:ListThemeAliases"
"quicksight:ListThemeVersions"
Owner
"quicksight:DescribeTheme"
"quicksight:DescribeThemeAlias"
"quicksight:ListThemeAliases"
"quicksight:ListThemeVersions"
"quicksight:DeleteTheme"
"quicksight:UpdateTheme"
"quicksight:CreateThemeAlias"
"quicksight:DeleteThemeAlias"
"quicksight:UpdateThemeAlias"
"quicksight:UpdateThemePermissions"
"quicksight:DescribeThemePermissions"
To specify no permissions, omit the permissions list.
updateThemePermissionsRequest - AccessDeniedException - You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that 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.UnsupportedUserEditionException - This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't 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.UpdateUserResult updateUser(UpdateUserRequest updateUserRequest)
Updates an Amazon QuickSight user.
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.PreconditionNotMetException - One or more preconditions aren't met.InternalFailureException - An internal failure occurred.ResourceUnavailableException - This resource is currently unavailable.void shutdown()
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 a request.
request - The originally executed request.