@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 |
---|---|
BatchCreateTopicReviewedAnswerResult |
batchCreateTopicReviewedAnswer(BatchCreateTopicReviewedAnswerRequest batchCreateTopicReviewedAnswerRequest)
Creates new reviewed answers for a Q Topic.
|
BatchDeleteTopicReviewedAnswerResult |
batchDeleteTopicReviewedAnswer(BatchDeleteTopicReviewedAnswerRequest batchDeleteTopicReviewedAnswerRequest)
Deletes reviewed answers for Q Topic.
|
CancelIngestionResult |
cancelIngestion(CancelIngestionRequest cancelIngestionRequest)
Cancels an ongoing ingestion of data into SPICE.
|
CreateAccountCustomizationResult |
createAccountCustomization(CreateAccountCustomizationRequest createAccountCustomizationRequest)
Creates Amazon QuickSight customizations for the current Amazon Web Services Region.
|
CreateAccountSubscriptionResult |
createAccountSubscription(CreateAccountSubscriptionRequest createAccountSubscriptionRequest)
Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.
|
CreateAnalysisResult |
createAnalysis(CreateAnalysisRequest createAnalysisRequest)
Creates an analysis in Amazon QuickSight.
|
CreateDashboardResult |
createDashboard(CreateDashboardRequest createDashboardRequest)
Creates a dashboard from either a template or directly with a
DashboardDefinition . |
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)
Use the
CreateGroup operation to create a group in Amazon QuickSight. |
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 for a dataset.
|
CreateNamespaceResult |
createNamespace(CreateNamespaceRequest createNamespaceRequest)
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
|
CreateRefreshScheduleResult |
createRefreshSchedule(CreateRefreshScheduleRequest createRefreshScheduleRequest)
Creates a refresh schedule for a dataset.
|
CreateRoleMembershipResult |
createRoleMembership(CreateRoleMembershipRequest createRoleMembershipRequest)
Use
CreateRoleMembership to add an existing Amazon QuickSight group to an existing role. |
CreateTemplateResult |
createTemplate(CreateTemplateRequest createTemplateRequest)
Creates a template either from a
TemplateDefinition or 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.
|
CreateTopicResult |
createTopic(CreateTopicRequest createTopicRequest)
Creates a new Q topic.
|
CreateTopicRefreshScheduleResult |
createTopicRefreshSchedule(CreateTopicRefreshScheduleRequest createTopicRefreshScheduleRequest)
Creates a topic refresh schedule.
|
CreateVPCConnectionResult |
createVPCConnection(CreateVPCConnectionRequest createVPCConnectionRequest)
Creates a new VPC connection.
|
DeleteAccountCustomizationResult |
deleteAccountCustomization(DeleteAccountCustomizationRequest deleteAccountCustomizationRequest)
Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web
Services account and Amazon QuickSight namespace.
|
DeleteAccountSubscriptionResult |
deleteAccountSubscription(DeleteAccountSubscriptionRequest deleteAccountSubscriptionRequest)
Use the
DeleteAccountSubscription operation to delete an Amazon QuickSight account. |
DeleteAnalysisResult |
deleteAnalysis(DeleteAnalysisRequest deleteAnalysisRequest)
Deletes an analysis from Amazon QuickSight.
|
DeleteDashboardResult |
deleteDashboard(DeleteDashboardRequest deleteDashboardRequest)
Deletes a dashboard.
|
DeleteDataSetResult |
deleteDataSet(DeleteDataSetRequest deleteDataSetRequest)
Deletes a dataset.
|
DeleteDataSetRefreshPropertiesResult |
deleteDataSetRefreshProperties(DeleteDataSetRefreshPropertiesRequest deleteDataSetRefreshPropertiesRequest)
Deletes the dataset refresh properties of the 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.
|
DeleteIdentityPropagationConfigResult |
deleteIdentityPropagationConfig(DeleteIdentityPropagationConfigRequest deleteIdentityPropagationConfigRequest)
Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight
IAM Identity Center application.
|
DeleteNamespaceResult |
deleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest)
Deletes a namespace and the users and groups that are associated with the namespace.
|
DeleteRefreshScheduleResult |
deleteRefreshSchedule(DeleteRefreshScheduleRequest deleteRefreshScheduleRequest)
Deletes a refresh schedule from a dataset.
|
DeleteRoleCustomPermissionResult |
deleteRoleCustomPermission(DeleteRoleCustomPermissionRequest deleteRoleCustomPermissionRequest)
Removes custom permissions from the role.
|
DeleteRoleMembershipResult |
deleteRoleMembership(DeleteRoleMembershipRequest deleteRoleMembershipRequest)
Removes a group from a role.
|
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.
|
DeleteTopicResult |
deleteTopic(DeleteTopicRequest deleteTopicRequest)
Deletes a topic.
|
DeleteTopicRefreshScheduleResult |
deleteTopicRefreshSchedule(DeleteTopicRefreshScheduleRequest deleteTopicRefreshScheduleRequest)
Deletes a topic refresh schedule.
|
DeleteUserResult |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes the Amazon QuickSight user that is associated with the identity of the IAM user or role that's making the
call.
|
DeleteUserByPrincipalIdResult |
deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest deleteUserByPrincipalIdRequest)
Deletes a user identified by its principal ID.
|
DeleteVPCConnectionResult |
deleteVPCConnection(DeleteVPCConnectionRequest deleteVPCConnectionRequest)
Deletes a VPC connection.
|
DescribeAccountCustomizationResult |
describeAccountCustomization(DescribeAccountCustomizationRequest describeAccountCustomizationRequest)
Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon
QuickSight namespace in an Amazon Web Services Region.
|
DescribeAccountSettingsResult |
describeAccountSettings(DescribeAccountSettingsRequest describeAccountSettingsRequest)
Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon
Web Services account.
|
DescribeAccountSubscriptionResult |
describeAccountSubscription(DescribeAccountSubscriptionRequest describeAccountSubscriptionRequest)
Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's
subscription.
|
DescribeAnalysisResult |
describeAnalysis(DescribeAnalysisRequest describeAnalysisRequest)
Provides a summary of the metadata for an analysis.
|
DescribeAnalysisDefinitionResult |
describeAnalysisDefinition(DescribeAnalysisDefinitionRequest describeAnalysisDefinitionRequest)
Provides a detailed description of the definition of an analysis.
|
DescribeAnalysisPermissionsResult |
describeAnalysisPermissions(DescribeAnalysisPermissionsRequest describeAnalysisPermissionsRequest)
Provides the read and write permissions for an analysis.
|
DescribeAssetBundleExportJobResult |
describeAssetBundleExportJob(DescribeAssetBundleExportJobRequest describeAssetBundleExportJobRequest)
Describes an existing export job.
|
DescribeAssetBundleImportJobResult |
describeAssetBundleImportJob(DescribeAssetBundleImportJobRequest describeAssetBundleImportJobRequest)
Describes an existing import job.
|
DescribeDashboardResult |
describeDashboard(DescribeDashboardRequest describeDashboardRequest)
Provides a summary for a dashboard.
|
DescribeDashboardDefinitionResult |
describeDashboardDefinition(DescribeDashboardDefinitionRequest describeDashboardDefinitionRequest)
Provides a detailed description of the definition of a dashboard.
|
DescribeDashboardPermissionsResult |
describeDashboardPermissions(DescribeDashboardPermissionsRequest describeDashboardPermissionsRequest)
Describes read and write permissions for a dashboard.
|
DescribeDashboardSnapshotJobResult |
describeDashboardSnapshotJob(DescribeDashboardSnapshotJobRequest describeDashboardSnapshotJobRequest)
Describes an existing snapshot job.
|
DescribeDashboardSnapshotJobResultResult |
describeDashboardSnapshotJobResult(DescribeDashboardSnapshotJobResultRequest describeDashboardSnapshotJobResultRequest)
Describes the result of an existing snapshot job that has finished running.
|
DescribeDataSetResult |
describeDataSet(DescribeDataSetRequest describeDataSetRequest)
Describes a dataset.
|
DescribeDataSetPermissionsResult |
describeDataSetPermissions(DescribeDataSetPermissionsRequest describeDataSetPermissionsRequest)
Describes the permissions on a dataset.
|
DescribeDataSetRefreshPropertiesResult |
describeDataSetRefreshProperties(DescribeDataSetRefreshPropertiesRequest describeDataSetRefreshPropertiesRequest)
Describes the refresh properties of 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).
|
DescribeGroupMembershipResult |
describeGroupMembership(DescribeGroupMembershipRequest describeGroupMembershipRequest)
Use the
DescribeGroupMembership operation to determine if a user is a member of the specified group. |
DescribeIAMPolicyAssignmentResult |
describeIAMPolicyAssignment(DescribeIAMPolicyAssignmentRequest describeIAMPolicyAssignmentRequest)
Describes an existing IAM policy assignment, as specified by the assignment name.
|
DescribeIngestionResult |
describeIngestion(DescribeIngestionRequest describeIngestionRequest)
Describes a SPICE ingestion.
|
DescribeIpRestrictionResult |
describeIpRestriction(DescribeIpRestrictionRequest describeIpRestrictionRequest)
Provides a summary and status of IP rules.
|
DescribeKeyRegistrationResult |
describeKeyRegistration(DescribeKeyRegistrationRequest describeKeyRegistrationRequest)
Describes all customer managed key registrations in a Amazon QuickSight account.
|
DescribeNamespaceResult |
describeNamespace(DescribeNamespaceRequest describeNamespaceRequest)
Describes the current namespace.
|
DescribeRefreshScheduleResult |
describeRefreshSchedule(DescribeRefreshScheduleRequest describeRefreshScheduleRequest)
Provides a summary of a refresh schedule.
|
DescribeRoleCustomPermissionResult |
describeRoleCustomPermission(DescribeRoleCustomPermissionRequest describeRoleCustomPermissionRequest)
Describes all custom permissions that are mapped to a role.
|
DescribeTemplateResult |
describeTemplate(DescribeTemplateRequest describeTemplateRequest)
Describes a template's metadata.
|
DescribeTemplateAliasResult |
describeTemplateAlias(DescribeTemplateAliasRequest describeTemplateAliasRequest)
Describes the template alias for a template.
|
DescribeTemplateDefinitionResult |
describeTemplateDefinition(DescribeTemplateDefinitionRequest describeTemplateDefinitionRequest)
Provides a detailed description of the definition of 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.
|
DescribeTopicResult |
describeTopic(DescribeTopicRequest describeTopicRequest)
Describes a topic.
|
DescribeTopicPermissionsResult |
describeTopicPermissions(DescribeTopicPermissionsRequest describeTopicPermissionsRequest)
Describes the permissions of a topic.
|
DescribeTopicRefreshResult |
describeTopicRefresh(DescribeTopicRefreshRequest describeTopicRefreshRequest)
Describes the status of a topic refresh.
|
DescribeTopicRefreshScheduleResult |
describeTopicRefreshSchedule(DescribeTopicRefreshScheduleRequest describeTopicRefreshScheduleRequest)
Deletes a topic refresh schedule.
|
DescribeUserResult |
describeUser(DescribeUserRequest describeUserRequest)
Returns information about a user, given the user name.
|
DescribeVPCConnectionResult |
describeVPCConnection(DescribeVPCConnectionRequest describeVPCConnectionRequest)
Describes a VPC connection.
|
GenerateEmbedUrlForAnonymousUserResult |
generateEmbedUrlForAnonymousUser(GenerateEmbedUrlForAnonymousUserRequest generateEmbedUrlForAnonymousUserRequest)
Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website,
without having to register any reader users.
|
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 temporary session URL and authorization code(bearer token) that you can use to embed an Amazon
QuickSight read-only dashboard in your website or application.
|
GetSessionEmbedUrlResult |
getSessionEmbedUrl(GetSessionEmbedUrlRequest getSessionEmbedUrlRequest)
Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in
your web server code.
|
ListAnalysesResult |
listAnalyses(ListAnalysesRequest listAnalysesRequest)
Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
|
ListAssetBundleExportJobsResult |
listAssetBundleExportJobs(ListAssetBundleExportJobsRequest listAssetBundleExportJobsRequest)
Lists all asset bundle export jobs that have been taken place in the last 14 days.
|
ListAssetBundleImportJobsResult |
listAssetBundleImportJobs(ListAssetBundleImportJobsRequest listAssetBundleImportJobsRequest)
Lists all asset bundle import jobs that have taken place in the last 14 days.
|
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 Amazon 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 the IAM policy assignments in the current Amazon QuickSight account.
|
ListIAMPolicyAssignmentsForUserResult |
listIAMPolicyAssignmentsForUser(ListIAMPolicyAssignmentsForUserRequest listIAMPolicyAssignmentsForUserRequest)
Lists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies
assigned to the specified user and group, or groups that the user belongs to.
|
ListIdentityPropagationConfigsResult |
listIdentityPropagationConfigs(ListIdentityPropagationConfigsRequest listIdentityPropagationConfigsRequest)
Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access.
|
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.
|
ListRefreshSchedulesResult |
listRefreshSchedules(ListRefreshSchedulesRequest listRefreshSchedulesRequest)
Lists the refresh schedules of a dataset.
|
ListRoleMembershipsResult |
listRoleMemberships(ListRoleMembershipsRequest listRoleMembershipsRequest)
Lists all groups that are associated with a role.
|
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.
|
ListTopicRefreshSchedulesResult |
listTopicRefreshSchedules(ListTopicRefreshSchedulesRequest listTopicRefreshSchedulesRequest)
Lists all of the refresh schedules for a topic.
|
ListTopicReviewedAnswersResult |
listTopicReviewedAnswers(ListTopicReviewedAnswersRequest listTopicReviewedAnswersRequest)
Lists all reviewed answers for a Q Topic.
|
ListTopicsResult |
listTopics(ListTopicsRequest listTopicsRequest)
Lists all of the topics within an 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.
|
ListVPCConnectionsResult |
listVPCConnections(ListVPCConnectionsRequest listVPCConnectionsRequest)
Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
|
PutDataSetRefreshPropertiesResult |
putDataSetRefreshProperties(PutDataSetRefreshPropertiesRequest putDataSetRefreshPropertiesRequest)
Creates or updates the dataset refresh properties for the dataset.
|
RegisterUserResult |
registerUser(RegisterUserRequest registerUserRequest)
Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM)
identity or role specified in the request.
|
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.
|
SearchDataSetsResult |
searchDataSets(SearchDataSetsRequest searchDataSetsRequest)
Use the
SearchDataSets operation to search for datasets that belong to an account. |
SearchDataSourcesResult |
searchDataSources(SearchDataSourcesRequest searchDataSourcesRequest)
Use the
SearchDataSources operation to search for data sources that belong to an account. |
SearchFoldersResult |
searchFolders(SearchFoldersRequest searchFoldersRequest)
Searches the subfolders in a folder.
|
SearchGroupsResult |
searchGroups(SearchGroupsRequest searchGroupsRequest)
Use the
SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the
supplied filters. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartAssetBundleExportJobResult |
startAssetBundleExportJob(StartAssetBundleExportJobRequest startAssetBundleExportJobRequest)
Starts an Asset Bundle export job.
|
StartAssetBundleImportJobResult |
startAssetBundleImportJob(StartAssetBundleImportJobRequest startAssetBundleImportJobRequest)
Starts an Asset Bundle import job.
|
StartDashboardSnapshotJobResult |
startDashboardSnapshotJob(StartDashboardSnapshotJobRequest startDashboardSnapshotJobRequest)
Starts an asynchronous job that generates a snapshot of a dashboard's output.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag or tags from a resource.
|
UpdateAccountCustomizationResult |
updateAccountCustomization(UpdateAccountCustomizationRequest updateAccountCustomizationRequest)
Updates Amazon QuickSight customizations for 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.
|
UpdateDashboardLinksResult |
updateDashboardLinks(UpdateDashboardLinksRequest updateDashboardLinksRequest)
Updates the linked analyses on a dashboard.
|
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.
|
UpdateIdentityPropagationConfigResult |
updateIdentityPropagationConfig(UpdateIdentityPropagationConfigRequest updateIdentityPropagationConfigRequest)
Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center
application can access.
|
UpdateIpRestrictionResult |
updateIpRestriction(UpdateIpRestrictionRequest updateIpRestrictionRequest)
Updates the content and status of IP rules.
|
UpdateKeyRegistrationResult |
updateKeyRegistration(UpdateKeyRegistrationRequest updateKeyRegistrationRequest)
Updates a customer managed key in a Amazon QuickSight account.
|
UpdatePublicSharingSettingsResult |
updatePublicSharingSettings(UpdatePublicSharingSettingsRequest updatePublicSharingSettingsRequest)
Use the
UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of
an Amazon QuickSight dashboard. |
UpdateRefreshScheduleResult |
updateRefreshSchedule(UpdateRefreshScheduleRequest updateRefreshScheduleRequest)
Updates a refresh schedule for a dataset.
|
UpdateRoleCustomPermissionResult |
updateRoleCustomPermission(UpdateRoleCustomPermissionRequest updateRoleCustomPermissionRequest)
Updates the custom permissions that are associated with a role.
|
UpdateSPICECapacityConfigurationResult |
updateSPICECapacityConfiguration(UpdateSPICECapacityConfigurationRequest updateSPICECapacityConfigurationRequest)
Updates the SPICE capacity configuration for a Amazon QuickSight account.
|
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.
|
UpdateTopicResult |
updateTopic(UpdateTopicRequest updateTopicRequest)
Updates a topic.
|
UpdateTopicPermissionsResult |
updateTopicPermissions(UpdateTopicPermissionsRequest updateTopicPermissionsRequest)
Updates the permissions of a topic.
|
UpdateTopicRefreshScheduleResult |
updateTopicRefreshSchedule(UpdateTopicRefreshScheduleRequest updateTopicRefreshScheduleRequest)
Updates a topic refresh schedule.
|
UpdateUserResult |
updateUser(UpdateUserRequest updateUserRequest)
Updates an Amazon QuickSight user.
|
UpdateVPCConnectionResult |
updateVPCConnection(UpdateVPCConnectionRequest updateVPCConnectionRequest)
Updates a VPC connection.
|
static final String ENDPOINT_PREFIX
BatchCreateTopicReviewedAnswerResult batchCreateTopicReviewedAnswer(BatchCreateTopicReviewedAnswerRequest batchCreateTopicReviewedAnswerRequest)
Creates new reviewed answers for a Q Topic.
batchCreateTopicReviewedAnswerRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InternalFailureException
- An internal failure occurred.BatchDeleteTopicReviewedAnswerResult batchDeleteTopicReviewedAnswer(BatchDeleteTopicReviewedAnswerRequest batchDeleteTopicReviewedAnswerRequest)
Deletes reviewed answers for Q Topic.
batchDeleteTopicReviewedAnswerRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InternalFailureException
- An internal failure occurred.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
credentials.InvalidParameterValueException
- 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 for 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 Amazon QuickSight by removing Amazon
QuickSight sample assets and videos for all new users, see Customizing Amazon
QuickSight in the Amazon QuickSight User Guide.
You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a
QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply
to an Amazon Web Services account. To find out which customizations apply, use the
DescribeAccountCustomization
API operation.
Before you use the CreateAccountCustomization
API operation to add a theme as the namespace default,
make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme
isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the
current permissions by using 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
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.CreateAccountSubscriptionResult createAccountSubscription(CreateAccountSubscriptionRequest createAccountSubscriptionRequest)
Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.
The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK.
Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon QuickSight User Guide. The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon QuickSight in the Amazon QuickSight User Guide.
If your IAM policy includes both the Subscribe
and CreateAccountSubscription
actions,
make sure that both actions are set to Allow
. If either action is set to Deny
, the
Deny
action prevails and your API call fails.
You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the Amazon QuickSight User Guide.
You can't set default resource access on the new account from the Amazon QuickSight API. Instead, add default resource access from the Amazon QuickSight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon QuickSight User Guide.
createAccountSubscriptionRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.ResourceExistsException
- The resource specified already exists.PreconditionNotMetException
- One or more preconditions aren't met.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.CreateAnalysisResult createAnalysis(CreateAnalysisRequest createAnalysisRequest)
Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an
AnalysisDefinition
.
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 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.CreateDashboardResult createDashboard(CreateDashboardRequest createDashboardRequest)
Creates a dashboard from either a template or directly with a DashboardDefinition
. To first create a
template, see the
CreateTemplate
API operation.
A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
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 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.CreateDataSetResult createDataSet(CreateDataSetRequest createDataSetRequest)
Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
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
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.LimitExceededException
- A limit is exceeded.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.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
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.LimitExceededException
- A limit is exceeded.ResourceNotFoundException
- One or more resources can't be found.ResourceExistsException
- The resource specified already exists.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.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 Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.LimitExceededException
- A limit is exceeded.InternalFailureException
- An internal failure occurred.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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ResourceExistsException
- The resource specified already exists.ThrottlingException
- Access is throttled.LimitExceededException
- A limit is exceeded.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.CreateGroupResult createGroup(CreateGroupRequest createGroupRequest)
Use the CreateGroup
operation to create a group in Amazon QuickSight. You can create up to 10,000
groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact Amazon Web Services
Support.
The permissions resource is
arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name>
.
The response is a group object.
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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.PreconditionNotMetException
- One or more preconditions aren't met.LimitExceededException
- A limit is exceeded.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.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
credentials.InvalidParameterValueException
- 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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.ConcurrentUpdatingException
- A resource is already in a state that indicates an operation is happening that must complete before a new
update can be applied.InternalFailureException
- An internal failure occurred.CreateIngestionResult createIngestion(CreateIngestionRequest createIngestionRequest)
Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time.
Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
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
credentials.InvalidParameterValueException
- 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 Amazon QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.
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
credentials.InvalidParameterValueException
- 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.CreateRefreshScheduleResult createRefreshSchedule(CreateRefreshScheduleRequest createRefreshScheduleRequest)
Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
createRefreshScheduleRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- 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.CreateRoleMembershipResult createRoleMembership(CreateRoleMembershipRequest createRoleMembershipRequest)
Use CreateRoleMembership
to add an existing Amazon QuickSight group to an existing role.
createRoleMembershipRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- 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.CreateTemplateResult createTemplate(CreateTemplateRequest createTemplateRequest)
Creates a template either from a TemplateDefinition
or from an existing Amazon QuickSight analysis
or template. You can use the resulting template to create additional dashboards, templates, or analyses.
A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
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
credentials.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.LimitExceededException
- A limit is exceeded.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InternalFailureException
- An internal failure occurred.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 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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.LimitExceededException
- A limit is exceeded.InternalFailureException
- An internal failure occurred.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 Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.CreateTopicResult createTopic(CreateTopicRequest createTopicRequest)
Creates a new Q topic.
createTopicRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.LimitExceededException
- A limit is exceeded.ResourceNotFoundException
- One or more resources can't be found.ResourceExistsException
- The resource specified already exists.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.CreateTopicRefreshScheduleResult createTopicRefreshSchedule(CreateTopicRefreshScheduleRequest createTopicRefreshScheduleRequest)
Creates a topic refresh schedule.
createTopicRefreshScheduleRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.LimitExceededException
- A limit is exceeded.ResourceNotFoundException
- One or more resources can't be found.ResourceExistsException
- The resource specified already exists.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.CreateVPCConnectionResult createVPCConnection(CreateVPCConnectionRequest createVPCConnectionRequest)
Creates a new VPC connection.
createVPCConnectionRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.LimitExceededException
- A limit is exceeded.ResourceExistsException
- The resource specified already exists.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.DeleteAccountCustomizationResult deleteAccountCustomization(DeleteAccountCustomizationRequest deleteAccountCustomizationRequest)
Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.
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
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.LimitExceededException
- A limit is exceeded.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.DeleteAccountSubscriptionResult deleteAccountSubscription(DeleteAccountSubscriptionRequest deleteAccountSubscriptionRequest)
Use the DeleteAccountSubscription
operation to delete an Amazon QuickSight account. This operation
will result in an error message if you have configured your account termination protection settings to
True
. To change this setting and delete your account, call the UpdateAccountSettings
API and set the value of the TerminationProtectionEnabled
parameter to False
, then make
another call to the DeleteAccountSubscription
API.
deleteAccountSubscriptionRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- 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.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. Amazon
QuickSight attaches a DeletionTime
stamp to the response that specifies the end of the recovery
window. At the end of the recovery window, Amazon QuickSight deletes the analysis permanently.
At any time before recovery window ends, you can use the RestoreAnalysis
API operation to remove 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 Amazon 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 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 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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InternalFailureException
- An internal failure occurred.DeleteDataSetRefreshPropertiesResult deleteDataSetRefreshProperties(DeleteDataSetRefreshPropertiesRequest deleteDataSetRefreshPropertiesRequest)
Deletes the dataset refresh properties of the dataset.
deleteDataSetRefreshPropertiesRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.LimitExceededException
- A limit is exceeded.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InternalFailureException
- An internal failure occurred.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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InternalFailureException
- An internal failure occurred.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
credentials.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- Updating or deleting a resource can cause an inconsistent state.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.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
credentials.InvalidParameterValueException
- 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
credentials.InvalidParameterValueException
- 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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.ConcurrentUpdatingException
- A resource is already in a state that indicates an operation is happening that must complete before a new
update can be applied.InternalFailureException
- An internal failure occurred.DeleteIdentityPropagationConfigResult deleteIdentityPropagationConfig(DeleteIdentityPropagationConfigRequest deleteIdentityPropagationConfigRequest)
Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application.
This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.
deleteIdentityPropagationConfigRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- 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.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
credentials.InvalidParameterValueException
- 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.DeleteRefreshScheduleResult deleteRefreshSchedule(DeleteRefreshScheduleRequest deleteRefreshScheduleRequest)
Deletes a refresh schedule from a dataset.
deleteRefreshScheduleRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.LimitExceededException
- A limit is exceeded.InternalFailureException
- An internal failure occurred.DeleteRoleCustomPermissionResult deleteRoleCustomPermission(DeleteRoleCustomPermissionRequest deleteRoleCustomPermissionRequest)
Removes custom permissions from the role.
deleteRoleCustomPermissionRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- 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.DeleteRoleMembershipResult deleteRoleMembership(DeleteRoleMembershipRequest deleteRoleMembershipRequest)
Removes a group from a role.
deleteRoleMembershipRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- 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 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 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
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.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 Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.DeleteTopicResult deleteTopic(DeleteTopicRequest deleteTopicRequest)
Deletes a topic.
deleteTopicRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InternalFailureException
- An internal failure occurred.DeleteTopicRefreshScheduleResult deleteTopicRefreshSchedule(DeleteTopicRefreshScheduleRequest deleteTopicRefreshScheduleRequest)
Deletes a topic refresh schedule.
deleteTopicRefreshScheduleRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.LimitExceededException
- A limit is exceeded.ResourceNotFoundException
- One or more resources can't be found.ResourceExistsException
- The resource specified already exists.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)
Deletes the Amazon QuickSight user that is associated with the identity of the IAM user or role that's making the call. The IAM user isn't deleted as a result of this call.
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
credentials.InvalidParameterValueException
- 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
credentials.InvalidParameterValueException
- 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.DeleteVPCConnectionResult deleteVPCConnection(DeleteVPCConnectionRequest deleteVPCConnectionRequest)
Deletes a VPC connection.
deleteVPCConnectionRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.DescribeAccountCustomizationResult describeAccountCustomization(DescribeAccountCustomizationRequest describeAccountCustomizationRequest)
Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon
QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which
customizations to apply by running this API operation with the Resolved
flag included.
To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.
Amazon Web Services account
- The Amazon Web Services account exists at the top of the hierarchy. It
has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you
subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region. That's
where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services
Region.
Amazon Web Services Region
- In each Amazon Web Services Region where you sign in to Amazon
QuickSight at least once, Amazon QuickSight acts as a separate instance of the same service. If you have a user
directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have
access to Amazon QuickSight in any Amazon Web Services Region, unless they are constrained to a namespace.
To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options:
Use command line options.
Use named profiles.
Run aws configure
to change your default Amazon Web Services Region. Use Enter to key the same
settings for your keys. For more information, see Configuring the CLI.
Namespace
- A QuickSight namespace is a partition that contains users and assets (data sources,
datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also
be part of the same namespace. People who share a namespace are completely isolated from users and assets in
other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region.
Applied customizations
- Within an Amazon Web Services Region, a set of Amazon QuickSight
customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a
namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a
single Amazon Web Services Region. To apply them in other Amazon Web Services Regions, run 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
credentials.InvalidParameterValueException
- 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 Amazon 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
credentials.InvalidParameterValueException
- 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.DescribeAccountSubscriptionResult describeAccountSubscription(DescribeAccountSubscriptionRequest describeAccountSubscriptionRequest)
Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's
subscription. A successful API call returns an AccountInfo
object that includes an account's name,
subscription status, authentication type, edition, and notification email address.
describeAccountSubscriptionRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- 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
credentials.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.DescribeAnalysisDefinitionResult describeAnalysisDefinition(DescribeAnalysisDefinitionRequest describeAnalysisDefinitionRequest)
Provides a detailed description of the definition of an analysis.
If you do not need to know details about the content of an Analysis, for instance if you are trying to check the
status of a recently created or updated Analysis, use the
DescribeAnalysis
instead.
describeAnalysisDefinitionRequest
- InvalidParameterValueException
- One or more parameters has a value that isn't valid.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.ConflictException
- Updating or deleting a resource can cause an inconsistent state.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.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 Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.DescribeAssetBundleExportJobResult describeAssetBundleExportJob(DescribeAssetBundleExportJobRequest describeAssetBundleExportJobRequest)
Describes an existing export job.
Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to
download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You
can call the DescribeAssetBundleExportJob
API for a new download URL as needed.
Job descriptions are available for 14 days after the job starts.
describeAssetBundleExportJobRequest
- UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.DescribeAssetBundleImportJobResult describeAssetBundleImportJob(DescribeAssetBundleImportJobRequest describeAssetBundleImportJobRequest)
Describes an existing import job.
Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.
describeAssetBundleImportJobRequest
- UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.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
credentials.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.DescribeDashboardDefinitionResult describeDashboardDefinition(DescribeDashboardDefinitionRequest describeDashboardDefinitionRequest)
Provides a detailed description of the definition of a dashboard.
If you do not need to know details about the content of a dashboard, for instance if you are trying to check the
status of a recently created or updated dashboard, use the
DescribeDashboard
instead.
describeDashboardDefinitionRequest
- InvalidParameterValueException
- One or more parameters has a value that isn't valid.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.ConflictException
- Updating or deleting a resource can cause an inconsistent state.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.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 Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.DescribeDashboardSnapshotJobResult describeDashboardSnapshotJob(DescribeDashboardSnapshotJobRequest describeDashboardSnapshotJobRequest)
Describes an existing snapshot job.
Poll job descriptions after a job starts to know the status of the job. For information on available status
codes, see JobStatus
.
describeDashboardSnapshotJobRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.DescribeDashboardSnapshotJobResultResult describeDashboardSnapshotJobResult(DescribeDashboardSnapshotJobResultRequest describeDashboardSnapshotJobResultRequest)
Describes the result of an existing snapshot job that has finished running.
A finished snapshot job will return a COMPLETED
or FAILED
status when you poll the job
with a DescribeDashboardSnapshotJob
API call.
If the job has not finished running, this operation returns a message that says
Dashboard Snapshot Job with id <SnapshotjobId> has not reached a terminal state.
.
describeDashboardSnapshotJobResultRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.DescribeDataSetResult describeDataSet(DescribeDataSetRequest describeDataSetRequest)
Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.
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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InternalFailureException
- An internal failure occurred.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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InternalFailureException
- An internal failure occurred.DescribeDataSetRefreshPropertiesResult describeDataSetRefreshProperties(DescribeDataSetRefreshPropertiesRequest describeDataSetRefreshPropertiesRequest)
Describes the refresh properties of a dataset.
describeDataSetRefreshPropertiesRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.LimitExceededException
- A limit is exceeded.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InternalFailureException
- An internal failure occurred.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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InternalFailureException
- An internal failure occurred.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
credentials.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.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
credentials.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.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
credentials.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.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
credentials.InvalidParameterValueException
- 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.DescribeGroupMembershipResult describeGroupMembership(DescribeGroupMembershipRequest describeGroupMembershipRequest)
Use the DescribeGroupMembership
operation to determine if a user is a member of the specified group.
If the user exists and is a member of the specified group, an associated GroupMember
object is
returned.
describeGroupMembershipRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- 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
credentials.InvalidParameterValueException
- 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
credentials.InvalidParameterValueException
- 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.DescribeIpRestrictionResult describeIpRestriction(DescribeIpRestrictionRequest describeIpRestrictionRequest)
Provides a summary and status of IP rules.
describeIpRestrictionRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InternalFailureException
- An internal failure occurred.DescribeKeyRegistrationResult describeKeyRegistration(DescribeKeyRegistrationRequest describeKeyRegistrationRequest)
Describes all customer managed key registrations in a Amazon QuickSight account.
describeKeyRegistrationRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.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
credentials.InvalidParameterValueException
- 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.DescribeRefreshScheduleResult describeRefreshSchedule(DescribeRefreshScheduleRequest describeRefreshScheduleRequest)
Provides a summary of a refresh schedule.
describeRefreshScheduleRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.LimitExceededException
- A limit is exceeded.InternalFailureException
- An internal failure occurred.DescribeRoleCustomPermissionResult describeRoleCustomPermission(DescribeRoleCustomPermissionRequest describeRoleCustomPermissionRequest)
Describes all custom permissions that are mapped to a role.
describeRoleCustomPermissionRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- 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.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
credentials.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.ConflictException
- Updating or deleting a resource can cause an inconsistent state.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.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 Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.DescribeTemplateDefinitionResult describeTemplateDefinition(DescribeTemplateDefinitionRequest describeTemplateDefinitionRequest)
Provides a detailed description of the definition of a template.
If you do not need to know details about the content of a template, for instance if you are trying to check the
status of a recently created or updated template, use the
DescribeTemplate
instead.
describeTemplateDefinitionRequest
- InvalidParameterValueException
- One or more parameters has a value that isn't valid.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.ConflictException
- Updating or deleting a resource can cause an inconsistent state.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.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 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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.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 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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.DescribeTopicResult describeTopic(DescribeTopicRequest describeTopicRequest)
Describes a topic.
describeTopicRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InternalFailureException
- An internal failure occurred.DescribeTopicPermissionsResult describeTopicPermissions(DescribeTopicPermissionsRequest describeTopicPermissionsRequest)
Describes the permissions of a topic.
describeTopicPermissionsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InternalFailureException
- An internal failure occurred.DescribeTopicRefreshResult describeTopicRefresh(DescribeTopicRefreshRequest describeTopicRefreshRequest)
Describes the status of a topic refresh.
describeTopicRefreshRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InternalFailureException
- An internal failure occurred.DescribeTopicRefreshScheduleResult describeTopicRefreshSchedule(DescribeTopicRefreshScheduleRequest describeTopicRefreshScheduleRequest)
Deletes a topic refresh schedule.
describeTopicRefreshScheduleRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.LimitExceededException
- A limit is exceeded.ResourceNotFoundException
- One or more resources can't be found.ResourceExistsException
- The resource specified already exists.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.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
credentials.InvalidParameterValueException
- 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.DescribeVPCConnectionResult describeVPCConnection(DescribeVPCConnectionRequest describeVPCConnectionRequest)
Describes a VPC connection.
describeVPCConnectionRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.GenerateEmbedUrlForAnonymousUserResult generateEmbedUrlForAnonymousUser(GenerateEmbedUrlForAnonymousUserRequest generateEmbedUrlForAnonymousUserRequest)
Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutes
parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default
session duration is 10 hours.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.SessionLifetimeInMinutesInvalidException
- The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be
15-600 minutes.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.UnsupportedPricingPlanException
- This error indicates that you are calling an embedding operation in Amazon QuickSight without the
required pricing plan on your Amazon Web Services account. Before you can use embedding for anonymous
users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You can do this on
the Manage Amazon QuickSight page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrl
API operation with the --identity-type ANONYMOUS
option.
InternalFailureException
- An internal failure occurred.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 (minimum) to 10 hours (maximum). The default session duration is 10 hours.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.QuickSightUserNotFoundException
- The user with the provided name isn't found. This error can happen in any operation that requires finding
a user based on a provided user name, such as DeleteUser
, DescribeUser
, and so
on.ResourceNotFoundException
- One or more resources can't be found.SessionLifetimeInMinutesInvalidException
- The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be
15-600 minutes.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.UnsupportedPricingPlanException
- This error indicates that you are calling an embedding operation in Amazon QuickSight without the
required pricing plan on your Amazon Web Services account. Before you can use embedding for anonymous
users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You can do this on
the Manage Amazon QuickSight page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrl
API operation with the --identity-type ANONYMOUS
option.
InternalFailureException
- An internal failure occurred.GetDashboardEmbedUrlResult getDashboardEmbedUrl(GetDashboardEmbedUrlRequest getDashboardEmbedUrlRequest)
Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions.
Currently, you can use GetDashboardEmbedURL
only from the server, not from the user's browser. The
following rules apply to the generated URL:
They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional
SessionLifetimeInMinutes
parameter to customize session duration.
For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.DomainNotWhitelistedException
- The domain specified isn't on the allow list. All domains for embedded dashboards must be added to the
approved list by an Amazon QuickSight admin.QuickSightUserNotFoundException
- The user with the provided name isn't found. This error can happen in any operation that requires finding
a user based on a provided user name, such as DeleteUser
, DescribeUser
, and so
on.IdentityTypeNotSupportedException
- The identity type specified isn't supported. Supported identity types include IAM
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 Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.UnsupportedPricingPlanException
- This error indicates that you are calling an embedding operation in Amazon QuickSight without the
required pricing plan on your Amazon Web Services account. Before you can use embedding for anonymous
users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You can do this on
the Manage Amazon QuickSight page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrl
API operation with the --identity-type ANONYMOUS
option.
InternalFailureException
- An internal failure occurred.GetSessionEmbedUrlResult getSessionEmbedUrl(GetSessionEmbedUrlRequest getSessionEmbedUrlRequest)
Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in
your web server code. Use GetSessionEmbedUrl
where you want to provide an authoring portal that
allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon
QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to
some of these features, add a custom permissions profile to the user with 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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.QuickSightUserNotFoundException
- The user with the provided name isn't found. This error can happen in any operation that requires finding
a user based on a provided user name, such as DeleteUser
, DescribeUser
, and so
on.SessionLifetimeInMinutesInvalidException
- The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be
15-600 minutes.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.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 Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.ListAssetBundleExportJobsResult listAssetBundleExportJobs(ListAssetBundleExportJobsRequest listAssetBundleExportJobsRequest)
Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days
ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs,
ListAssetBundleExportJobs
only returns the most recent job that uses the repeated job ID.
listAssetBundleExportJobsRequest
- UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.ThrottlingException
- Access is throttled.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidNextTokenException
- The NextToken
value isn't valid.ResourceNotFoundException
- One or more resources can't be found.ListAssetBundleImportJobsResult listAssetBundleImportJobs(ListAssetBundleImportJobsRequest listAssetBundleImportJobsRequest)
Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago
are deleted forever and are not returned. If you are using the same job ID for multiple jobs,
ListAssetBundleImportJobs
only returns the most recent job that uses the repeated job ID.
listAssetBundleImportJobsRequest
- UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.ThrottlingException
- Access is throttled.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidNextTokenException
- The NextToken
value isn't valid.ResourceNotFoundException
- One or more resources can't be found.ListDashboardVersionsResult listDashboardVersions(ListDashboardVersionsRequest listDashboardVersionsRequest)
Lists all the versions of the dashboards in the Amazon 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 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 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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.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
credentials.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.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
credentials.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.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
credentials.InvalidParameterValueException
- 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
credentials.InvalidParameterValueException
- 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 the 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
credentials.InvalidParameterValueException
- 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 of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to.
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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.ConcurrentUpdatingException
- A resource is already in a state that indicates an operation is happening that must complete before a new
update can be applied.InternalFailureException
- An internal failure occurred.ListIdentityPropagationConfigsResult listIdentityPropagationConfigs(ListIdentityPropagationConfigsRequest listIdentityPropagationConfigsRequest)
Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access.
This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.
listIdentityPropagationConfigsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- 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.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
credentials.InvalidParameterValueException
- 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. This operation doesn't list deleted namespaces.
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
credentials.InvalidParameterValueException
- 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.ListRefreshSchedulesResult listRefreshSchedules(ListRefreshSchedulesRequest listRefreshSchedulesRequest)
Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.
listRefreshSchedulesRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.LimitExceededException
- A limit is exceeded.InternalFailureException
- An internal failure occurred.ListRoleMembershipsResult listRoleMemberships(ListRoleMembershipsRequest listRoleMembershipsRequest)
Lists all groups that are associated with a role.
listRoleMembershipsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.PreconditionNotMetException
- One or more preconditions aren't met.LimitExceededException
- A limit is exceeded.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.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
credentials.InvalidParameterValueException
- 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 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 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 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 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
credentials.InvalidNextTokenException
- The NextToken
value isn't valid.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.InvalidNextTokenException
- The NextToken
value isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.ListTopicRefreshSchedulesResult listTopicRefreshSchedules(ListTopicRefreshSchedulesRequest listTopicRefreshSchedulesRequest)
Lists all of the refresh schedules for a topic.
listTopicRefreshSchedulesRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.LimitExceededException
- A limit is exceeded.ResourceNotFoundException
- One or more resources can't be found.ResourceExistsException
- The resource specified already exists.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.ListTopicReviewedAnswersResult listTopicReviewedAnswers(ListTopicReviewedAnswersRequest listTopicReviewedAnswersRequest)
Lists all reviewed answers for a Q Topic.
listTopicReviewedAnswersRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InternalFailureException
- An internal failure occurred.ListTopicsResult listTopics(ListTopicsRequest listTopicsRequest)
Lists all of the topics within an account.
listTopicsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.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
credentials.InvalidParameterValueException
- 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
credentials.InvalidParameterValueException
- 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.ListVPCConnectionsResult listVPCConnections(ListVPCConnectionsRequest listVPCConnectionsRequest)
Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
listVPCConnectionsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.PutDataSetRefreshPropertiesResult putDataSetRefreshProperties(PutDataSetRefreshPropertiesRequest putDataSetRefreshPropertiesRequest)
Creates or updates the dataset refresh properties for the dataset.
putDataSetRefreshPropertiesRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.LimitExceededException
- A limit is exceeded.PreconditionNotMetException
- One or more preconditions aren't met.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InternalFailureException
- An internal failure occurred.RegisterUserResult registerUser(RegisterUserRequest registerUserRequest)
Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see Inviting users to access Amazon QuickSight.
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
credentials.InvalidParameterValueException
- 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 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 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 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.SearchDataSetsResult searchDataSets(SearchDataSetsRequest searchDataSetsRequest)
Use the SearchDataSets
operation to search for datasets that belong to an account.
searchDataSetsRequest
- ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InvalidParameterValueException
- One or more parameters has a value that isn't valid.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.SearchDataSourcesResult searchDataSources(SearchDataSourcesRequest searchDataSourcesRequest)
Use the SearchDataSources
operation to search for data sources that belong to an account.
searchDataSourcesRequest
- ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InvalidParameterValueException
- One or more parameters has a value that isn't valid.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.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
credentials.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InvalidRequestException
- You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services
support.InternalFailureException
- An internal failure occurred.SearchGroupsResult searchGroups(SearchGroupsRequest searchGroupsRequest)
Use the SearchGroups
operation to search groups in a specified Amazon QuickSight namespace using the
supplied filters.
searchGroupsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- 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.StartAssetBundleExportJobResult startAssetBundleExportJob(StartAssetBundleExportJobRequest startAssetBundleExportJobRequest)
Starts an Asset Bundle export job.
An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset
dependencies in the same job. Export jobs run asynchronously and can be polled with a
DescribeAssetBundleExportJob
API call. When a job is successfully completed, a download URL that
contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a
DescribeAssetBundleExportJob
API call. Each Amazon QuickSight account can run up to 5 export jobs
concurrently.
The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
startAssetBundleExportJobRequest
- UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.LimitExceededException
- A limit is exceeded.ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- One or more resources can't be found.StartAssetBundleImportJobResult startAssetBundleImportJob(StartAssetBundleImportJobRequest startAssetBundleImportJobRequest)
Starts an Asset Bundle import job.
An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently.
The API caller must have the necessary "create"
, "describe"
, and "update"
permissions in their IAM role to access each resource type that is contained in the bundle file before the
resources can be imported.
startAssetBundleImportJobRequest
- UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.LimitExceededException
- A limit is exceeded.ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- One or more resources can't be found.StartDashboardSnapshotJobResult startDashboardSnapshotJob(StartDashboardSnapshotJobRequest startDashboardSnapshotJobRequest)
Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.
1 Paginated PDF
1 Excel workbook that includes up to 5 table or pivot table visuals
5 CSVs from table or pivot table visuals
The status of a submitted job can be polled with the DescribeDashboardSnapshotJob
API. When you call
the DescribeDashboardSnapshotJob
API, check the JobStatus
field in the response. Once
the job reaches a COMPLETED
or FAILED
status, use the
DescribeDashboardSnapshotJobResult
API to obtain the URLs for the generated files. If the job fails,
the DescribeDashboardSnapshotJobResult
API returns detailed information about the error that
occurred.
StartDashboardSnapshotJob API throttling
Amazon QuickSight utilizes API throttling to create a more consistent user experience within a time span for
customers when they call the StartDashboardSnapshotJob
. By default, 12 jobs can run simlutaneously
in one Amazon Web Services account and users can submit up 10 API requests per second before an account is
throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Amazon
QuickSight throttles the API calls to maintin an optimal experience and reliability for all Amazon QuickSight
users.
Common throttling scenarios
The following list provides information about the most commin throttling scenarios that can occur.
A large number of SnapshotExport
API jobs are running simultaneously on an Amazon Web Services
account. When a new StartDashboardSnapshotJob
is created and there are already 12 jobs with the
RUNNING
status, the new job request fails and returns a LimitExceededException
error.
Wait for a current job to comlpete before you resubmit the new job.
A large number of API requests are submitted on an Amazon Web Services account. When a user makes more
than 10 API calls to the Amazon QuickSight API in one second, a ThrottlingException
is returned.
If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account.
Best practices to handle throttling
If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of
API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for
the total processing time of your projected load that stays within the throttling limits of the Amazon QuickSight
APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in
parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply
the duration by 9, for example (12 minutes * 9 = 108 minutes)
. Use the new result to determine the
latest time at which the jobs need to be started to meet your target deadline.
The time that it takes to process a job can be impacted by the following factors:
The dataset type (Direct Query or SPICE).
The size of the dataset.
The complexity of the calculated fields that are used in the dashboard.
The number of visuals that are on a sheet.
The types of visuals that are on the sheet.
The number of formats and snapshots that are requested in the job configuration.
The size of the generated snapshots.
startDashboardSnapshotJobRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.LimitExceededException
- A limit is exceeded.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.UnsupportedPricingPlanException
- This error indicates that you are calling an embedding operation in Amazon QuickSight without the
required pricing plan on your Amazon Web Services account. Before you can use embedding for anonymous
users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You can do this on
the Manage Amazon QuickSight page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrl
API operation with the --identity-type ANONYMOUS
option.
InternalFailureException
- An internal failure occurred.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by
granting a user permission to access or change only resources with certain tag values. You can use the
TagResource
operation with a resource that already has tags. If you specify a new tag key for the
resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is
already associated with the resource, the new tag value that you specify replaces the previous value for that
tag.
You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, template, topic, and user.
Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following:
Tags are used to track costs for users in Amazon QuickSight. You can't tag other resources that Amazon QuickSight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units.
Amazon QuickSight doesn't currently support the tag editor for Resource Groups.
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
credentials.InvalidParameterValueException
- 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
credentials.InvalidParameterValueException
- 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 for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.
You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon
QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an
Amazon Web Services account. To find out which customizations apply, use the
DescribeAccountCustomization
API operation.
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
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.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
credentials.InvalidParameterValueException
- 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 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 Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.ConflictException
- Updating or deleting a resource can cause an inconsistent state.LimitExceededException
- A limit is exceeded.InternalFailureException
- An internal failure occurred.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 Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.UpdateDashboardLinksResult updateDashboardLinks(UpdateDashboardLinksRequest updateDashboardLinksRequest)
Updates the linked analyses on a dashboard.
updateDashboardLinksRequest
- ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- Updating or deleting a resource can cause an inconsistent state.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.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 Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.ConflictException
- Updating or deleting a resource can cause an inconsistent state.LimitExceededException
- A limit is exceeded.InternalFailureException
- An internal failure occurred.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 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. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.
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
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.LimitExceededException
- A limit is exceeded.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.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
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.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
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InternalFailureException
- An internal failure occurred.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
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.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
credentials.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- Updating or deleting a resource can cause an inconsistent state.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.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
credentials.LimitExceededException
- A limit is exceeded.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.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
credentials.InvalidParameterValueException
- 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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.ConcurrentUpdatingException
- A resource is already in a state that indicates an operation is happening that must complete before a new
update can be applied.InternalFailureException
- An internal failure occurred.UpdateIdentityPropagationConfigResult updateIdentityPropagationConfig(UpdateIdentityPropagationConfigRequest updateIdentityPropagationConfigRequest)
Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access.
This operation is only supported for Amazon QuickSight accounts using IAM Identity Center
updateIdentityPropagationConfigRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- 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.UpdateIpRestrictionResult updateIpRestriction(UpdateIpRestrictionRequest updateIpRestrictionRequest)
Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the
IpRestrictionRule
, VpcIdRestrictionRule
, or VpcEndpointIdRestrictionRule
.
To use this operation, you must provide the entire map of rules. You can use the
DescribeIpRestriction
operation to get the current rule map.
updateIpRestrictionRequest
- LimitExceededException
- A limit is exceeded.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InternalFailureException
- An internal failure occurred.UpdateKeyRegistrationResult updateKeyRegistration(UpdateKeyRegistrationRequest updateKeyRegistrationRequest)
Updates a customer managed key in a Amazon QuickSight account.
updateKeyRegistrationRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.UpdatePublicSharingSettingsResult updatePublicSharingSettings(UpdatePublicSharingSettingsRequest updatePublicSharingSettingsRequest)
Use the UpdatePublicSharingSettings
operation to turn on or turn off the public sharing settings of
an Amazon QuickSight dashboard.
To use this operation, turn on session capacity pricing for your Amazon QuickSight account.
Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon QuickSight, see Using Amazon QuickSight with IAM in the Amazon QuickSight User Guide.
updatePublicSharingSettingsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedPricingPlanException
- This error indicates that you are calling an embedding operation in Amazon QuickSight without the
required pricing plan on your Amazon Web Services account. Before you can use embedding for anonymous
users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You can do this on
the Manage Amazon QuickSight page.
After capacity pricing is added, you can use the
GetDashboardEmbedUrl
API operation with the --identity-type ANONYMOUS
option.
InternalFailureException
- An internal failure occurred.UpdateRefreshScheduleResult updateRefreshSchedule(UpdateRefreshScheduleRequest updateRefreshScheduleRequest)
Updates a refresh schedule for a dataset.
updateRefreshScheduleRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.LimitExceededException
- A limit is exceeded.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.UpdateRoleCustomPermissionResult updateRoleCustomPermission(UpdateRoleCustomPermissionRequest updateRoleCustomPermissionRequest)
Updates the custom permissions that are associated with a role.
updateRoleCustomPermissionRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- 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.UpdateSPICECapacityConfigurationResult updateSPICECapacityConfiguration(UpdateSPICECapacityConfigurationRequest updateSPICECapacityConfigurationRequest)
Updates the SPICE capacity configuration for a Amazon QuickSight account.
updateSPICECapacityConfigurationRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.InvalidParameterValueException
- 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.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 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 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 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.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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.LimitExceededException
- A limit is exceeded.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.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 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
credentials.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.LimitExceededException
- A limit is exceeded.InternalFailureException
- An internal failure occurred.UpdateTopicResult updateTopic(UpdateTopicRequest updateTopicRequest)
Updates a topic.
updateTopicRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.LimitExceededException
- A limit is exceeded.ResourceNotFoundException
- One or more resources can't be found.ResourceExistsException
- The resource specified already exists.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.UpdateTopicPermissionsResult updateTopicPermissions(UpdateTopicPermissionsRequest updateTopicPermissionsRequest)
Updates the permissions of a topic.
updateTopicPermissionsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.ConflictException
- Updating or deleting a resource can cause an inconsistent state.LimitExceededException
- A limit is exceeded.InternalFailureException
- An internal failure occurred.UpdateTopicRefreshScheduleResult updateTopicRefreshSchedule(UpdateTopicRefreshScheduleRequest updateTopicRefreshScheduleRequest)
Updates a topic refresh schedule.
updateTopicRefreshScheduleRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.LimitExceededException
- A limit is exceeded.ResourceNotFoundException
- One or more resources can't be found.ResourceExistsException
- The resource specified already exists.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.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
credentials.InvalidParameterValueException
- 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.UpdateVPCConnectionResult updateVPCConnection(UpdateVPCConnectionRequest updateVPCConnectionRequest)
Updates a VPC connection.
updateVPCConnectionRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
credentials.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.LimitExceededException
- A limit is exceeded.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.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.