@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonQuickSightClient extends AmazonWebServiceClient implements AmazonQuickSight
Amazon QuickSight is a fully managed, serverless business intelligence service for the 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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
static AmazonQuickSightClientBuilder |
builder() |
CancelIngestionResult |
cancelIngestion(CancelIngestionRequest request)
Cancels an ongoing ingestion of data into SPICE.
|
CreateAccountCustomizationResult |
createAccountCustomization(CreateAccountCustomizationRequest request)
Creates Amazon QuickSight customizations the current Amazon Web Services Region.
|
CreateAnalysisResult |
createAnalysis(CreateAnalysisRequest request)
Creates an analysis in Amazon QuickSight.
|
CreateDashboardResult |
createDashboard(CreateDashboardRequest request)
Creates a dashboard from a template.
|
CreateDataSetResult |
createDataSet(CreateDataSetRequest request)
Creates a dataset.
|
CreateDataSourceResult |
createDataSource(CreateDataSourceRequest request)
Creates a data source.
|
CreateFolderResult |
createFolder(CreateFolderRequest request)
Creates an empty shared folder.
|
CreateFolderMembershipResult |
createFolderMembership(CreateFolderMembershipRequest request)
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
|
CreateGroupResult |
createGroup(CreateGroupRequest request)
Creates an Amazon QuickSight group.
|
CreateGroupMembershipResult |
createGroupMembership(CreateGroupMembershipRequest request)
Adds an Amazon QuickSight user to an Amazon QuickSight group.
|
CreateIAMPolicyAssignmentResult |
createIAMPolicyAssignment(CreateIAMPolicyAssignmentRequest request)
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN).
|
CreateIngestionResult |
createIngestion(CreateIngestionRequest request)
Creates and starts a new SPICE ingestion for a dataset.
|
CreateNamespaceResult |
createNamespace(CreateNamespaceRequest request)
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
|
CreateTemplateResult |
createTemplate(CreateTemplateRequest request)
Creates a template from an existing Amazon QuickSight analysis or template.
|
CreateTemplateAliasResult |
createTemplateAlias(CreateTemplateAliasRequest request)
Creates a template alias for a template.
|
CreateThemeResult |
createTheme(CreateThemeRequest request)
Creates a theme.
|
CreateThemeAliasResult |
createThemeAlias(CreateThemeAliasRequest request)
Creates a theme alias for a theme.
|
DeleteAccountCustomizationResult |
deleteAccountCustomization(DeleteAccountCustomizationRequest request)
Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web
Services account and Amazon QuickSight namespace.
|
DeleteAnalysisResult |
deleteAnalysis(DeleteAnalysisRequest request)
Deletes an analysis from Amazon QuickSight.
|
DeleteDashboardResult |
deleteDashboard(DeleteDashboardRequest request)
Deletes a dashboard.
|
DeleteDataSetResult |
deleteDataSet(DeleteDataSetRequest request)
Deletes a dataset.
|
DeleteDataSourceResult |
deleteDataSource(DeleteDataSourceRequest request)
Deletes the data source permanently.
|
DeleteFolderResult |
deleteFolder(DeleteFolderRequest request)
Deletes an empty folder.
|
DeleteFolderMembershipResult |
deleteFolderMembership(DeleteFolderMembershipRequest request)
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
|
DeleteGroupResult |
deleteGroup(DeleteGroupRequest request)
Removes a user group from Amazon QuickSight.
|
DeleteGroupMembershipResult |
deleteGroupMembership(DeleteGroupMembershipRequest request)
Removes a user from a group so that the user is no longer a member of the group.
|
DeleteIAMPolicyAssignmentResult |
deleteIAMPolicyAssignment(DeleteIAMPolicyAssignmentRequest request)
Deletes an existing IAM policy assignment.
|
DeleteNamespaceResult |
deleteNamespace(DeleteNamespaceRequest request)
Deletes a namespace and the users and groups that are associated with the namespace.
|
DeleteTemplateResult |
deleteTemplate(DeleteTemplateRequest request)
Deletes a template.
|
DeleteTemplateAliasResult |
deleteTemplateAlias(DeleteTemplateAliasRequest request)
Deletes the item that the specified template alias points to.
|
DeleteThemeResult |
deleteTheme(DeleteThemeRequest request)
Deletes a theme.
|
DeleteThemeAliasResult |
deleteThemeAlias(DeleteThemeAliasRequest request)
Deletes the version of the theme that the specified theme alias points to.
|
DeleteUserResult |
deleteUser(DeleteUserRequest request)
Deletes the Amazon QuickSight user that is associated with the identity of the Identity and Access Management
(IAM) user or role that's making the call.
|
DeleteUserByPrincipalIdResult |
deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest request)
Deletes a user identified by its principal ID.
|
DescribeAccountCustomizationResult |
describeAccountCustomization(DescribeAccountCustomizationRequest request)
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 request)
Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon
Web Services account.
|
DescribeAnalysisResult |
describeAnalysis(DescribeAnalysisRequest request)
Provides a summary of the metadata for an analysis.
|
DescribeAnalysisPermissionsResult |
describeAnalysisPermissions(DescribeAnalysisPermissionsRequest request)
Provides the read and write permissions for an analysis.
|
DescribeDashboardResult |
describeDashboard(DescribeDashboardRequest request)
Provides a summary for a dashboard.
|
DescribeDashboardPermissionsResult |
describeDashboardPermissions(DescribeDashboardPermissionsRequest request)
Describes read and write permissions for a dashboard.
|
DescribeDataSetResult |
describeDataSet(DescribeDataSetRequest request)
Describes a dataset.
|
DescribeDataSetPermissionsResult |
describeDataSetPermissions(DescribeDataSetPermissionsRequest request)
Describes the permissions on a dataset.
|
DescribeDataSourceResult |
describeDataSource(DescribeDataSourceRequest request)
Describes a data source.
|
DescribeDataSourcePermissionsResult |
describeDataSourcePermissions(DescribeDataSourcePermissionsRequest request)
Describes the resource permissions for a data source.
|
DescribeFolderResult |
describeFolder(DescribeFolderRequest request)
Describes a folder.
|
DescribeFolderPermissionsResult |
describeFolderPermissions(DescribeFolderPermissionsRequest request)
Describes permissions for a folder.
|
DescribeFolderResolvedPermissionsResult |
describeFolderResolvedPermissions(DescribeFolderResolvedPermissionsRequest request)
Describes the folder resolved permissions.
|
DescribeGroupResult |
describeGroup(DescribeGroupRequest request)
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
|
DescribeGroupMembershipResult |
describeGroupMembership(DescribeGroupMembershipRequest request)
Use the
DescribeGroupMembership operation to determine if a user is a member of the specified group. |
DescribeIAMPolicyAssignmentResult |
describeIAMPolicyAssignment(DescribeIAMPolicyAssignmentRequest request)
Describes an existing IAM policy assignment, as specified by the assignment name.
|
DescribeIngestionResult |
describeIngestion(DescribeIngestionRequest request)
Describes a SPICE ingestion.
|
DescribeIpRestrictionResult |
describeIpRestriction(DescribeIpRestrictionRequest request)
Provides a summary and status of IP rules.
|
DescribeNamespaceResult |
describeNamespace(DescribeNamespaceRequest request)
Describes the current namespace.
|
DescribeTemplateResult |
describeTemplate(DescribeTemplateRequest request)
Describes a template's metadata.
|
DescribeTemplateAliasResult |
describeTemplateAlias(DescribeTemplateAliasRequest request)
Describes the template alias for a template.
|
DescribeTemplatePermissionsResult |
describeTemplatePermissions(DescribeTemplatePermissionsRequest request)
Describes read and write permissions on a template.
|
DescribeThemeResult |
describeTheme(DescribeThemeRequest request)
Describes a theme.
|
DescribeThemeAliasResult |
describeThemeAlias(DescribeThemeAliasRequest request)
Describes the alias for a theme.
|
DescribeThemePermissionsResult |
describeThemePermissions(DescribeThemePermissionsRequest request)
Describes the read and write permissions for a theme.
|
DescribeUserResult |
describeUser(DescribeUserRequest request)
Returns information about a user, given the user name.
|
GenerateEmbedUrlForAnonymousUserResult |
generateEmbedUrlForAnonymousUser(GenerateEmbedUrlForAnonymousUserRequest request)
Generates an embed URL that you can use to embed an Amazon QuickSight dashboard in your website, without having
to register any reader users.
|
GenerateEmbedUrlForRegisteredUserResult |
generateEmbedUrlForRegisteredUser(GenerateEmbedUrlForRegisteredUserRequest request)
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 request)
Generates a session URL and authorization code that you can use to embed an Amazon Amazon QuickSight read-only
dashboard in your web server code.
|
GetSessionEmbedUrlResult |
getSessionEmbedUrl(GetSessionEmbedUrlRequest request)
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 request)
Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
|
ListDashboardsResult |
listDashboards(ListDashboardsRequest request)
Lists dashboards in an Amazon Web Services account.
|
ListDashboardVersionsResult |
listDashboardVersions(ListDashboardVersionsRequest request)
Lists all the versions of the dashboards in the Amazon QuickSight subscription.
|
ListDataSetsResult |
listDataSets(ListDataSetsRequest request)
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
|
ListDataSourcesResult |
listDataSources(ListDataSourcesRequest request)
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
|
ListFolderMembersResult |
listFolderMembers(ListFolderMembersRequest request)
List all assets (
DASHBOARD , ANALYSIS , and DATASET ) in a folder. |
ListFoldersResult |
listFolders(ListFoldersRequest request)
Lists all folders in an account.
|
ListGroupMembershipsResult |
listGroupMemberships(ListGroupMembershipsRequest request)
Lists member users in a group.
|
ListGroupsResult |
listGroups(ListGroupsRequest request)
Lists all user groups in Amazon QuickSight.
|
ListIAMPolicyAssignmentsResult |
listIAMPolicyAssignments(ListIAMPolicyAssignmentsRequest request)
Lists IAM policy assignments in the current Amazon QuickSight account.
|
ListIAMPolicyAssignmentsForUserResult |
listIAMPolicyAssignmentsForUser(ListIAMPolicyAssignmentsForUserRequest request)
Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to
the specified user and group or groups that the user belongs to.
|
ListIngestionsResult |
listIngestions(ListIngestionsRequest request)
Lists the history of SPICE ingestions for a dataset.
|
ListNamespacesResult |
listNamespaces(ListNamespacesRequest request)
Lists the namespaces for the specified Amazon Web Services account.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists the tags assigned to a resource.
|
ListTemplateAliasesResult |
listTemplateAliases(ListTemplateAliasesRequest request)
Lists all the aliases of a template.
|
ListTemplatesResult |
listTemplates(ListTemplatesRequest request)
Lists all the templates in the current Amazon QuickSight account.
|
ListTemplateVersionsResult |
listTemplateVersions(ListTemplateVersionsRequest request)
Lists all the versions of the templates in the current Amazon QuickSight account.
|
ListThemeAliasesResult |
listThemeAliases(ListThemeAliasesRequest request)
Lists all the aliases of a theme.
|
ListThemesResult |
listThemes(ListThemesRequest request)
Lists all the themes in the current Amazon Web Services account.
|
ListThemeVersionsResult |
listThemeVersions(ListThemeVersionsRequest request)
Lists all the versions of the themes in the current Amazon Web Services account.
|
ListUserGroupsResult |
listUserGroups(ListUserGroupsRequest request)
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
|
ListUsersResult |
listUsers(ListUsersRequest request)
Returns a list of all of the Amazon QuickSight users belonging to this account.
|
RegisterUserResult |
registerUser(RegisterUserRequest request)
Creates an Amazon QuickSight user, whose identity is associated with the Identity and Access Management (IAM)
identity or role specified in the request.
|
RestoreAnalysisResult |
restoreAnalysis(RestoreAnalysisRequest request)
Restores an analysis.
|
SearchAnalysesResult |
searchAnalyses(SearchAnalysesRequest request)
Searches for analyses that belong to the user specified in the filter.
|
SearchDashboardsResult |
searchDashboards(SearchDashboardsRequest request)
Searches for dashboards that belong to a user.
|
SearchFoldersResult |
searchFolders(SearchFoldersRequest request)
Searches the subfolders in a folder.
|
SearchGroupsResult |
searchGroups(SearchGroupsRequest request)
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.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes a tag or tags from a resource.
|
UpdateAccountCustomizationResult |
updateAccountCustomization(UpdateAccountCustomizationRequest request)
Updates Amazon QuickSight customizations the current Amazon Web Services Region.
|
UpdateAccountSettingsResult |
updateAccountSettings(UpdateAccountSettingsRequest request)
Updates the Amazon QuickSight settings in your Amazon Web Services account.
|
UpdateAnalysisResult |
updateAnalysis(UpdateAnalysisRequest request)
Updates an analysis in Amazon QuickSight
|
UpdateAnalysisPermissionsResult |
updateAnalysisPermissions(UpdateAnalysisPermissionsRequest request)
Updates the read and write permissions for an analysis.
|
UpdateDashboardResult |
updateDashboard(UpdateDashboardRequest request)
Updates a dashboard in an Amazon Web Services account.
|
UpdateDashboardPermissionsResult |
updateDashboardPermissions(UpdateDashboardPermissionsRequest request)
Updates read and write permissions on a dashboard.
|
UpdateDashboardPublishedVersionResult |
updateDashboardPublishedVersion(UpdateDashboardPublishedVersionRequest request)
Updates the published version of a dashboard.
|
UpdateDataSetResult |
updateDataSet(UpdateDataSetRequest request)
Updates a dataset.
|
UpdateDataSetPermissionsResult |
updateDataSetPermissions(UpdateDataSetPermissionsRequest request)
Updates the permissions on a dataset.
|
UpdateDataSourceResult |
updateDataSource(UpdateDataSourceRequest request)
Updates a data source.
|
UpdateDataSourcePermissionsResult |
updateDataSourcePermissions(UpdateDataSourcePermissionsRequest request)
Updates the permissions to a data source.
|
UpdateFolderResult |
updateFolder(UpdateFolderRequest request)
Updates the name of a folder.
|
UpdateFolderPermissionsResult |
updateFolderPermissions(UpdateFolderPermissionsRequest request)
Updates permissions of a folder.
|
UpdateGroupResult |
updateGroup(UpdateGroupRequest request)
Changes a group description.
|
UpdateIAMPolicyAssignmentResult |
updateIAMPolicyAssignment(UpdateIAMPolicyAssignmentRequest request)
Updates an existing IAM policy assignment.
|
UpdateIpRestrictionResult |
updateIpRestriction(UpdateIpRestrictionRequest request)
Updates the content and status of IP rules.
|
UpdatePublicSharingSettingsResult |
updatePublicSharingSettings(UpdatePublicSharingSettingsRequest request)
Use the UpdatePublicSharingSettings operation to enable or disable the public sharing settings of an Amazon
QuickSight dashboard.
|
UpdateTemplateResult |
updateTemplate(UpdateTemplateRequest request)
Updates a template from an existing Amazon QuickSight analysis or another template.
|
UpdateTemplateAliasResult |
updateTemplateAlias(UpdateTemplateAliasRequest request)
Updates the template alias of a template.
|
UpdateTemplatePermissionsResult |
updateTemplatePermissions(UpdateTemplatePermissionsRequest request)
Updates the resource permissions for a template.
|
UpdateThemeResult |
updateTheme(UpdateThemeRequest request)
Updates a theme.
|
UpdateThemeAliasResult |
updateThemeAlias(UpdateThemeAliasRequest request)
Updates an alias of a theme.
|
UpdateThemePermissionsResult |
updateThemePermissions(UpdateThemePermissionsRequest request)
Updates the resource permissions for a theme.
|
UpdateUserResult |
updateUser(UpdateUserRequest request)
Updates an Amazon QuickSight user.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AmazonQuickSightClientBuilder builder()
public CancelIngestionResult cancelIngestion(CancelIngestionRequest request)
Cancels an ongoing ingestion of data into SPICE.
cancelIngestion
in interface AmazonQuickSight
cancelIngestionRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.ResourceExistsException
- The resource specified already exists.InternalFailureException
- An internal failure occurred.public CreateAccountCustomizationResult createAccountCustomization(CreateAccountCustomizationRequest request)
Creates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, you can add a custom
default theme by using the CreateAccountCustomization
or UpdateAccountCustomization
API
operation. To further customize 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.
createAccountCustomization
in interface AmazonQuickSight
createAccountCustomizationRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.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.public CreateAnalysisResult createAnalysis(CreateAnalysisRequest request)
Creates an analysis in Amazon QuickSight.
createAnalysis
in interface AmazonQuickSight
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.InternalFailureException
- An internal failure occurred.public CreateDashboardResult createDashboard(CreateDashboardRequest request)
Creates a dashboard from a template. To first create a template, see the
CreateTemplate
API operation.
A dashboard is an entity in 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.
createDashboard
in interface AmazonQuickSight
createDashboardRequest
- ResourceNotFoundException
- One or more resources can't be found.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceExistsException
- The resource specified already exists.ConflictException
- Updating or deleting a resource can cause an inconsistent state.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public CreateDataSetResult createDataSet(CreateDataSetRequest request)
Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
createDataSet
in interface AmazonQuickSight
createDataSetRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.LimitExceededException
- A limit is exceeded.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public CreateDataSourceResult createDataSource(CreateDataSourceRequest request)
Creates a data source.
createDataSource
in interface AmazonQuickSight
createDataSourceRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.LimitExceededException
- A limit is exceeded.ResourceNotFoundException
- One or more resources can't be found.ResourceExistsException
- The resource specified already exists.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.public CreateFolderResult createFolder(CreateFolderRequest request)
Creates an empty shared folder.
createFolder
in interface AmazonQuickSight
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
access keys.LimitExceededException
- A limit is exceeded.InternalFailureException
- An internal failure occurred.public CreateFolderMembershipResult createFolderMembership(CreateFolderMembershipRequest request)
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
createFolderMembership
in interface AmazonQuickSight
createFolderMembershipRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ResourceExistsException
- The resource specified already exists.ThrottlingException
- Access is throttled.LimitExceededException
- A limit is exceeded.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public CreateGroupResult createGroup(CreateGroupRequest request)
Creates an Amazon QuickSight group.
The permissions resource is
arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name>
.
The response is a group object.
createGroup
in interface AmazonQuickSight
createGroupRequest
- The request object for this operation.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.PreconditionNotMetException
- One or more preconditions aren't met.LimitExceededException
- A limit is exceeded.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public CreateGroupMembershipResult createGroupMembership(CreateGroupMembershipRequest request)
Adds an Amazon QuickSight user to an Amazon QuickSight group.
createGroupMembership
in interface AmazonQuickSight
createGroupMembershipRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public CreateIAMPolicyAssignmentResult createIAMPolicyAssignment(CreateIAMPolicyAssignmentRequest request)
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy 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.
createIAMPolicyAssignment
in interface AmazonQuickSight
createIAMPolicyAssignmentRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.ConcurrentUpdatingException
- A resource is already in a state that indicates an operation is happening that must complete before a new
update can be applied.InternalFailureException
- An internal failure occurred.public CreateIngestionResult createIngestion(CreateIngestionRequest request)
Creates and starts a new SPICE ingestion 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.
createIngestion
in interface AmazonQuickSight
createIngestionRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.LimitExceededException
- A limit is exceeded.ResourceExistsException
- The resource specified already exists.InternalFailureException
- An internal failure occurred.public CreateNamespaceResult createNamespace(CreateNamespaceRequest request)
(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.
createNamespace
in interface AmazonQuickSight
createNamespaceRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.LimitExceededException
- A limit is exceeded.ResourceExistsException
- The resource specified already exists.PreconditionNotMetException
- One or more preconditions aren't met.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public CreateTemplateResult createTemplate(CreateTemplateRequest request)
Creates a template from an existing Amazon QuickSight analysis or template. You can use the resulting template to create a dashboard.
A template is an entity in 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.
createTemplate
in interface AmazonQuickSight
createTemplateRequest
- InvalidParameterValueException
- One or more parameters has a value that isn't valid.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.LimitExceededException
- A limit is exceeded.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InternalFailureException
- An internal failure occurred.public CreateTemplateAliasResult createTemplateAlias(CreateTemplateAliasRequest request)
Creates a template alias for a template.
createTemplateAlias
in interface AmazonQuickSight
createTemplateAliasRequest
- ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceExistsException
- The resource specified already exists.LimitExceededException
- A limit is exceeded.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InternalFailureException
- An internal failure occurred.public CreateThemeResult createTheme(CreateThemeRequest request)
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.
createTheme
in interface AmazonQuickSight
createThemeRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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.public CreateThemeAliasResult createThemeAlias(CreateThemeAliasRequest request)
Creates a theme alias for a theme.
createThemeAlias
in interface AmazonQuickSight
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.public DeleteAccountCustomizationResult deleteAccountCustomization(DeleteAccountCustomizationRequest request)
Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.
deleteAccountCustomization
in interface AmazonQuickSight
deleteAccountCustomizationRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.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.public DeleteAnalysisResult deleteAnalysis(DeleteAnalysisRequest request)
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.
deleteAnalysis
in interface AmazonQuickSight
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.public DeleteDashboardResult deleteDashboard(DeleteDashboardRequest request)
Deletes a dashboard.
deleteDashboard
in interface AmazonQuickSight
deleteDashboardRequest
- ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- One or more resources can't be found.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public DeleteDataSetResult deleteDataSet(DeleteDataSetRequest request)
Deletes a dataset.
deleteDataSet
in interface AmazonQuickSight
deleteDataSetRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InternalFailureException
- An internal failure occurred.public DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest request)
Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
deleteDataSource
in interface AmazonQuickSight
deleteDataSourceRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InternalFailureException
- An internal failure occurred.public DeleteFolderResult deleteFolder(DeleteFolderRequest request)
Deletes an empty folder.
deleteFolder
in interface AmazonQuickSight
deleteFolderRequest
- InvalidParameterValueException
- One or more parameters has a value that isn't valid.PreconditionNotMetException
- One or more preconditions aren't met.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- Updating or deleting a resource can cause an inconsistent state.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public DeleteFolderMembershipResult deleteFolderMembership(DeleteFolderMembershipRequest request)
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
deleteFolderMembership
in interface AmazonQuickSight
deleteFolderMembershipRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public DeleteGroupResult deleteGroup(DeleteGroupRequest request)
Removes a user group from Amazon QuickSight.
deleteGroup
in interface AmazonQuickSight
deleteGroupRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public DeleteGroupMembershipResult deleteGroupMembership(DeleteGroupMembershipRequest request)
Removes a user from a group so that the user is no longer a member of the group.
deleteGroupMembership
in interface AmazonQuickSight
deleteGroupMembershipRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public DeleteIAMPolicyAssignmentResult deleteIAMPolicyAssignment(DeleteIAMPolicyAssignmentRequest request)
Deletes an existing IAM policy assignment.
deleteIAMPolicyAssignment
in interface AmazonQuickSight
deleteIAMPolicyAssignmentRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.ConcurrentUpdatingException
- A resource is already in a state that indicates an operation is happening that must complete before a new
update can be applied.InternalFailureException
- An internal failure occurred.public DeleteNamespaceResult deleteNamespace(DeleteNamespaceRequest request)
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.
deleteNamespace
in interface AmazonQuickSight
deleteNamespaceRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public DeleteTemplateResult deleteTemplate(DeleteTemplateRequest request)
Deletes a template.
deleteTemplate
in interface AmazonQuickSight
deleteTemplateRequest
- InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.ConflictException
- Updating or deleting a resource can cause an inconsistent state.LimitExceededException
- A limit is exceeded.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public DeleteTemplateAliasResult deleteTemplateAlias(DeleteTemplateAliasRequest request)
Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
deleteTemplateAlias
in interface AmazonQuickSight
deleteTemplateAliasRequest
- ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InternalFailureException
- An internal failure occurred.public DeleteThemeResult deleteTheme(DeleteThemeRequest request)
Deletes a theme.
deleteTheme
in interface AmazonQuickSight
deleteThemeRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public DeleteThemeAliasResult deleteThemeAlias(DeleteThemeAliasRequest request)
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.
deleteThemeAlias
in interface AmazonQuickSight
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.public DeleteUserResult deleteUser(DeleteUserRequest request)
Deletes the Amazon QuickSight user that is associated with the identity of the Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.
deleteUser
in interface AmazonQuickSight
deleteUserRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public DeleteUserByPrincipalIdResult deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest request)
Deletes a user identified by its principal ID.
deleteUserByPrincipalId
in interface AmazonQuickSight
deleteUserByPrincipalIdRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public DescribeAccountCustomizationResult describeAccountCustomization(DescribeAccountCustomizationRequest request)
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.
describeAccountCustomization
in interface AmazonQuickSight
describeAccountCustomizationRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public DescribeAccountSettingsResult describeAccountSettings(DescribeAccountSettingsRequest request)
Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
describeAccountSettings
in interface AmazonQuickSight
describeAccountSettingsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public DescribeAnalysisResult describeAnalysis(DescribeAnalysisRequest request)
Provides a summary of the metadata for an analysis.
describeAnalysis
in interface AmazonQuickSight
describeAnalysisRequest
- InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public DescribeAnalysisPermissionsResult describeAnalysisPermissions(DescribeAnalysisPermissionsRequest request)
Provides the read and write permissions for an analysis.
describeAnalysisPermissions
in interface AmazonQuickSight
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.public DescribeDashboardResult describeDashboard(DescribeDashboardRequest request)
Provides a summary for a dashboard.
describeDashboard
in interface AmazonQuickSight
describeDashboardRequest
- InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public DescribeDashboardPermissionsResult describeDashboardPermissions(DescribeDashboardPermissionsRequest request)
Describes read and write permissions for a dashboard.
describeDashboardPermissions
in interface AmazonQuickSight
describeDashboardPermissionsRequest
- InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public DescribeDataSetResult describeDataSet(DescribeDataSetRequest request)
Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.
describeDataSet
in interface AmazonQuickSight
describeDataSetRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InternalFailureException
- An internal failure occurred.public DescribeDataSetPermissionsResult describeDataSetPermissions(DescribeDataSetPermissionsRequest request)
Describes the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id
.
describeDataSetPermissions
in interface AmazonQuickSight
describeDataSetPermissionsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InternalFailureException
- An internal failure occurred.public DescribeDataSourceResult describeDataSource(DescribeDataSourceRequest request)
Describes a data source.
describeDataSource
in interface AmazonQuickSight
describeDataSourceRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InternalFailureException
- An internal failure occurred.public DescribeDataSourcePermissionsResult describeDataSourcePermissions(DescribeDataSourcePermissionsRequest request)
Describes the resource permissions for a data source.
describeDataSourcePermissions
in interface AmazonQuickSight
describeDataSourcePermissionsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InternalFailureException
- An internal failure occurred.public DescribeFolderResult describeFolder(DescribeFolderRequest request)
Describes a folder.
describeFolder
in interface AmazonQuickSight
describeFolderRequest
- InvalidParameterValueException
- One or more parameters has a value that isn't valid.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public DescribeFolderPermissionsResult describeFolderPermissions(DescribeFolderPermissionsRequest request)
Describes permissions for a folder.
describeFolderPermissions
in interface AmazonQuickSight
describeFolderPermissionsRequest
- InvalidParameterValueException
- One or more parameters has a value that isn't valid.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public DescribeFolderResolvedPermissionsResult describeFolderResolvedPermissions(DescribeFolderResolvedPermissionsRequest request)
Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
describeFolderResolvedPermissions
in interface AmazonQuickSight
describeFolderResolvedPermissionsRequest
- InvalidParameterValueException
- One or more parameters has a value that isn't valid.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public DescribeGroupResult describeGroup(DescribeGroupRequest request)
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
describeGroup
in interface AmazonQuickSight
describeGroupRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public DescribeGroupMembershipResult describeGroupMembership(DescribeGroupMembershipRequest request)
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.
describeGroupMembership
in interface AmazonQuickSight
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
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public DescribeIAMPolicyAssignmentResult describeIAMPolicyAssignment(DescribeIAMPolicyAssignmentRequest request)
Describes an existing IAM policy assignment, as specified by the assignment name.
describeIAMPolicyAssignment
in interface AmazonQuickSight
describeIAMPolicyAssignmentRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.public DescribeIngestionResult describeIngestion(DescribeIngestionRequest request)
Describes a SPICE ingestion.
describeIngestion
in interface AmazonQuickSight
describeIngestionRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.ResourceExistsException
- The resource specified already exists.InternalFailureException
- An internal failure occurred.public DescribeIpRestrictionResult describeIpRestriction(DescribeIpRestrictionRequest request)
Provides a summary and status of IP rules.
describeIpRestriction
in interface AmazonQuickSight
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
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InternalFailureException
- An internal failure occurred.public DescribeNamespaceResult describeNamespace(DescribeNamespaceRequest request)
Describes the current namespace.
describeNamespace
in interface AmazonQuickSight
describeNamespaceRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public DescribeTemplateResult describeTemplate(DescribeTemplateRequest request)
Describes a template's metadata.
describeTemplate
in interface AmazonQuickSight
describeTemplateRequest
- InvalidParameterValueException
- One or more parameters has a value that isn't valid.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.ConflictException
- Updating or deleting a resource can cause an inconsistent state.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public DescribeTemplateAliasResult describeTemplateAlias(DescribeTemplateAliasRequest request)
Describes the template alias for a template.
describeTemplateAlias
in interface AmazonQuickSight
describeTemplateAliasRequest
- ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public DescribeTemplatePermissionsResult describeTemplatePermissions(DescribeTemplatePermissionsRequest request)
Describes read and write permissions on a template.
describeTemplatePermissions
in interface AmazonQuickSight
describeTemplatePermissionsRequest
- ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- One or more resources can't be found.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public DescribeThemeResult describeTheme(DescribeThemeRequest request)
Describes a theme.
describeTheme
in interface AmazonQuickSight
describeThemeRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public DescribeThemeAliasResult describeThemeAlias(DescribeThemeAliasRequest request)
Describes the alias for a theme.
describeThemeAlias
in interface AmazonQuickSight
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.public DescribeThemePermissionsResult describeThemePermissions(DescribeThemePermissionsRequest request)
Describes the read and write permissions for a theme.
describeThemePermissions
in interface AmazonQuickSight
describeThemePermissionsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public DescribeUserResult describeUser(DescribeUserRequest request)
Returns information about a user, given the user name.
describeUser
in interface AmazonQuickSight
describeUserRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public GenerateEmbedUrlForAnonymousUserResult generateEmbedUrlForAnonymousUser(GenerateEmbedUrlForAnonymousUserRequest request)
Generates an embed URL that you can use to embed an Amazon QuickSight dashboard in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutes
parameter.
The resulting user session is valid for 15 minutes (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.
generateEmbedUrlForAnonymousUser
in interface AmazonQuickSight
generateEmbedUrlForAnonymousUserRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.SessionLifetimeInMinutesInvalidException
- The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be
15-600 minutes.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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.public GenerateEmbedUrlForRegisteredUserResult generateEmbedUrlForRegisteredUser(GenerateEmbedUrlForRegisteredUserRequest request)
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.
generateEmbedUrlForRegisteredUser
in interface AmazonQuickSight
generateEmbedUrlForRegisteredUserRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.QuickSightUserNotFoundException
- The user with the provided name isn't found. This error can happen in any operation that requires finding
a user based on a provided user name, such as DeleteUser
, DescribeUser
, and so
on.ResourceNotFoundException
- One or more resources can't be found.SessionLifetimeInMinutesInvalidException
- The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be
15-600 minutes.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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.public GetDashboardEmbedUrlResult getDashboardEmbedUrl(GetDashboardEmbedUrlRequest request)
Generates a session URL and authorization code that you can use to embed an Amazon Amazon QuickSight read-only dashboard in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions.
Currently, you can use GetDashboardEmbedURL
only from the server, not from the user's browser. The
following rules apply to the combination of URL and authorization code:
They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
The resulting user session is valid for 10 hours.
For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
getDashboardEmbedUrl
in interface AmazonQuickSight
getDashboardEmbedUrlRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.DomainNotWhitelistedException
- The domain specified isn't on the allow list. All domains for embedded dashboards must be added to the
approved list by an Amazon QuickSight admin.QuickSightUserNotFoundException
- The user with the provided name isn't found. This error can happen in any operation that requires finding
a user based on a provided user name, such as DeleteUser
, DescribeUser
, and so
on.IdentityTypeNotSupportedException
- The identity type specified isn't supported. Supported identity types include IAM
and
QUICKSIGHT
.SessionLifetimeInMinutesInvalidException
- The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be
15-600 minutes.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon 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.public GetSessionEmbedUrlResult getSessionEmbedUrl(GetSessionEmbedUrlRequest request)
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:
getSessionEmbedUrl
in interface AmazonQuickSight
getSessionEmbedUrlRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.QuickSightUserNotFoundException
- The user with the provided name isn't found. This error can happen in any operation that requires finding
a user based on a provided user name, such as DeleteUser
, DescribeUser
, and so
on.SessionLifetimeInMinutesInvalidException
- The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be
15-600 minutes.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public ListAnalysesResult listAnalyses(ListAnalysesRequest request)
Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
listAnalyses
in interface AmazonQuickSight
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.public ListDashboardVersionsResult listDashboardVersions(ListDashboardVersionsRequest request)
Lists all the versions of the dashboards in the Amazon QuickSight subscription.
listDashboardVersions
in interface AmazonQuickSight
listDashboardVersionsRequest
- InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public ListDashboardsResult listDashboards(ListDashboardsRequest request)
Lists dashboards in an Amazon Web Services account.
listDashboards
in interface AmazonQuickSight
listDashboardsRequest
- ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public ListDataSetsResult listDataSets(ListDataSetsRequest request)
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*
.
listDataSets
in interface AmazonQuickSight
listDataSetsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.public ListDataSourcesResult listDataSources(ListDataSourcesRequest request)
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
listDataSources
in interface AmazonQuickSight
listDataSourcesRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.public ListFolderMembersResult listFolderMembers(ListFolderMembersRequest request)
List all assets (DASHBOARD
, ANALYSIS
, and DATASET
) in a folder.
listFolderMembers
in interface AmazonQuickSight
listFolderMembersRequest
- InvalidParameterValueException
- One or more parameters has a value that isn't valid.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public ListFoldersResult listFolders(ListFoldersRequest request)
Lists all folders in an account.
listFolders
in interface AmazonQuickSight
listFoldersRequest
- InvalidParameterValueException
- One or more parameters has a value that isn't valid.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public ListGroupMembershipsResult listGroupMemberships(ListGroupMembershipsRequest request)
Lists member users in a group.
listGroupMemberships
in interface AmazonQuickSight
listGroupMembershipsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public ListGroupsResult listGroups(ListGroupsRequest request)
Lists all user groups in Amazon QuickSight.
listGroups
in interface AmazonQuickSight
listGroupsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public ListIAMPolicyAssignmentsResult listIAMPolicyAssignments(ListIAMPolicyAssignmentsRequest request)
Lists IAM policy assignments in the current Amazon QuickSight account.
listIAMPolicyAssignments
in interface AmazonQuickSight
listIAMPolicyAssignmentsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.public ListIAMPolicyAssignmentsForUserResult listIAMPolicyAssignmentsForUser(ListIAMPolicyAssignmentsForUserRequest request)
Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to.
listIAMPolicyAssignmentsForUser
in interface AmazonQuickSight
listIAMPolicyAssignmentsForUserRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.ConcurrentUpdatingException
- A resource is already in a state that indicates an operation is happening that must complete before a new
update can be applied.InternalFailureException
- An internal failure occurred.public ListIngestionsResult listIngestions(ListIngestionsRequest request)
Lists the history of SPICE ingestions for a dataset.
listIngestions
in interface AmazonQuickSight
listIngestionsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.ResourceExistsException
- The resource specified already exists.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.public ListNamespacesResult listNamespaces(ListNamespacesRequest request)
Lists the namespaces for the specified Amazon Web Services account.
listNamespaces
in interface AmazonQuickSight
listNamespacesRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists the tags assigned to a resource.
listTagsForResource
in interface AmazonQuickSight
listTagsForResourceRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.public ListTemplateAliasesResult listTemplateAliases(ListTemplateAliasesRequest request)
Lists all the aliases of a template.
listTemplateAliases
in interface AmazonQuickSight
listTemplateAliasesRequest
- 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.public ListTemplateVersionsResult listTemplateVersions(ListTemplateVersionsRequest request)
Lists all the versions of the templates in the current Amazon QuickSight account.
listTemplateVersions
in interface AmazonQuickSight
listTemplateVersionsRequest
- ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public ListTemplatesResult listTemplates(ListTemplatesRequest request)
Lists all the templates in the current Amazon QuickSight account.
listTemplates
in interface AmazonQuickSight
listTemplatesRequest
- ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public ListThemeAliasesResult listThemeAliases(ListThemeAliasesRequest request)
Lists all the aliases of a theme.
listThemeAliases
in interface AmazonQuickSight
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.public ListThemeVersionsResult listThemeVersions(ListThemeVersionsRequest request)
Lists all the versions of the themes in the current Amazon Web Services account.
listThemeVersions
in interface AmazonQuickSight
listThemeVersionsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidNextTokenException
- The NextToken
value isn't valid.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public ListThemesResult listThemes(ListThemesRequest request)
Lists all the themes in the current Amazon Web Services account.
listThemes
in interface AmazonQuickSight
listThemesRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.InvalidNextTokenException
- The NextToken
value isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public ListUserGroupsResult listUserGroups(ListUserGroupsRequest request)
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
listUserGroups
in interface AmazonQuickSight
listUserGroupsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public ListUsersResult listUsers(ListUsersRequest request)
Returns a list of all of the Amazon QuickSight users belonging to this account.
listUsers
in interface AmazonQuickSight
listUsersRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public RegisterUserResult registerUser(RegisterUserRequest request)
Creates an Amazon QuickSight user, whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request.
registerUser
in interface AmazonQuickSight
registerUserRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.LimitExceededException
- A limit is exceeded.ResourceExistsException
- The resource specified already exists.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public RestoreAnalysisResult restoreAnalysis(RestoreAnalysisRequest request)
Restores an analysis.
restoreAnalysis
in interface AmazonQuickSight
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.public SearchAnalysesResult searchAnalyses(SearchAnalysesRequest request)
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.
searchAnalyses
in interface AmazonQuickSight
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.public SearchDashboardsResult searchDashboards(SearchDashboardsRequest request)
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.
searchDashboards
in interface AmazonQuickSight
searchDashboardsRequest
- ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InvalidParameterValueException
- One or more parameters has a value that isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InvalidNextTokenException
- The NextToken
value isn't valid.InternalFailureException
- An internal failure occurred.public SearchFoldersResult searchFolders(SearchFoldersRequest request)
Searches the subfolders in a folder.
searchFolders
in interface AmazonQuickSight
searchFoldersRequest
- InvalidParameterValueException
- One or more parameters has a value that isn't valid.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public SearchGroupsResult searchGroups(SearchGroupsRequest request)
Use the SearchGroups
operation to search groups in a specified Amazon QuickSight namespace using the
supplied filters.
searchGroups
in interface AmazonQuickSight
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
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InvalidNextTokenException
- The NextToken
value isn't valid.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public TagResourceResult tagResource(TagResourceRequest request)
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, and template.
Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following:
You can't use tags to track costs for Amazon QuickSight. This isn't possible because you can't tag the resources that Amazon QuickSight costs are based on, for example Amazon QuickSight storage capacity (SPICE), number of users, type of users, and usage metrics.
Amazon QuickSight doesn't currently support the tag editor for Resource Groups.
tagResource
in interface AmazonQuickSight
tagResourceRequest
- LimitExceededException
- A limit is exceeded.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes a tag or tags from a resource.
untagResource
in interface AmazonQuickSight
untagResourceRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.public UpdateAccountCustomizationResult updateAccountCustomization(UpdateAccountCustomizationRequest request)
Updates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, the only customization you can use is a theme.
You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a 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.
updateAccountCustomization
in interface AmazonQuickSight
updateAccountCustomizationRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.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.public UpdateAccountSettingsResult updateAccountSettings(UpdateAccountSettingsRequest request)
Updates the Amazon QuickSight settings in your Amazon Web Services account.
updateAccountSettings
in interface AmazonQuickSight
updateAccountSettingsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public UpdateAnalysisResult updateAnalysis(UpdateAnalysisRequest request)
Updates an analysis in Amazon QuickSight
updateAnalysis
in interface AmazonQuickSight
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.public UpdateAnalysisPermissionsResult updateAnalysisPermissions(UpdateAnalysisPermissionsRequest request)
Updates the read and write permissions for an analysis.
updateAnalysisPermissions
in interface AmazonQuickSight
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.InternalFailureException
- An internal failure occurred.public UpdateDashboardResult updateDashboard(UpdateDashboardRequest request)
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.
updateDashboard
in interface AmazonQuickSight
updateDashboardRequest
- ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- Updating or deleting a resource can cause an inconsistent state.LimitExceededException
- A limit is exceeded.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public UpdateDashboardPermissionsResult updateDashboardPermissions(UpdateDashboardPermissionsRequest request)
Updates read and write permissions on a dashboard.
updateDashboardPermissions
in interface AmazonQuickSight
updateDashboardPermissionsRequest
- ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InternalFailureException
- An internal failure occurred.public UpdateDashboardPublishedVersionResult updateDashboardPublishedVersion(UpdateDashboardPublishedVersionRequest request)
Updates the published version of a dashboard.
updateDashboardPublishedVersion
in interface AmazonQuickSight
updateDashboardPublishedVersionRequest
- InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- One or more resources can't be found.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public UpdateDataSetResult updateDataSet(UpdateDataSetRequest request)
Updates a dataset. This operation doesn't support datasets that include uploaded files as a source.
updateDataSet
in interface AmazonQuickSight
updateDataSetRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.LimitExceededException
- A limit is exceeded.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public UpdateDataSetPermissionsResult updateDataSetPermissions(UpdateDataSetPermissionsRequest request)
Updates the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id
.
updateDataSetPermissions
in interface AmazonQuickSight
updateDataSetPermissionsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.public UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest request)
Updates a data source.
updateDataSource
in interface AmazonQuickSight
updateDataSourceRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InternalFailureException
- An internal failure occurred.public UpdateDataSourcePermissionsResult updateDataSourcePermissions(UpdateDataSourcePermissionsRequest request)
Updates the permissions to a data source.
updateDataSourcePermissions
in interface AmazonQuickSight
updateDataSourcePermissionsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.InternalFailureException
- An internal failure occurred.public UpdateFolderResult updateFolder(UpdateFolderRequest request)
Updates the name of a folder.
updateFolder
in interface AmazonQuickSight
updateFolderRequest
- InvalidParameterValueException
- One or more parameters has a value that isn't valid.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- Updating or deleting a resource can cause an inconsistent state.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public UpdateFolderPermissionsResult updateFolderPermissions(UpdateFolderPermissionsRequest request)
Updates permissions of a folder.
updateFolderPermissions
in interface AmazonQuickSight
updateFolderPermissionsRequest
- InvalidParameterValueException
- One or more parameters has a value that isn't valid.AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.LimitExceededException
- A limit is exceeded.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public UpdateGroupResult updateGroup(UpdateGroupRequest request)
Changes a group description.
updateGroup
in interface AmazonQuickSight
updateGroupRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public UpdateIAMPolicyAssignmentResult updateIAMPolicyAssignment(UpdateIAMPolicyAssignmentRequest request)
Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that
are specified in the request. This overwrites all of the users included in Identities
.
updateIAMPolicyAssignment
in interface AmazonQuickSight
updateIAMPolicyAssignmentRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.ConcurrentUpdatingException
- A resource is already in a state that indicates an operation is happening that must complete before a new
update can be applied.InternalFailureException
- An internal failure occurred.public UpdateIpRestrictionResult updateIpRestriction(UpdateIpRestrictionRequest request)
Updates the content and status of IP rules. To use this operation, you need to provide the entire map of rules.
You can use the DescribeIpRestriction
operation to get the current rule map.
updateIpRestriction
in interface AmazonQuickSight
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
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.InternalFailureException
- An internal failure occurred.public UpdatePublicSharingSettingsResult updatePublicSharingSettings(UpdatePublicSharingSettingsRequest request)
Use the UpdatePublicSharingSettings operation to enable or disable the public sharing settings of an Amazon QuickSight dashboard.
To use this operation, enable session capacity pricing on your Amazon QuickSight account.
Before you can enable public sharing on your account, you need to allow public sharing permissions to an administrative user in the IAM console. For more information on using IAM with Amazon QuickSight, see Using Amazon QuickSight with IAM.
updatePublicSharingSettings
in interface AmazonQuickSight
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
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.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.public UpdateTemplateResult updateTemplate(UpdateTemplateRequest request)
Updates a template from an existing Amazon QuickSight analysis or another template.
updateTemplate
in interface AmazonQuickSight
updateTemplateRequest
- InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.ConflictException
- Updating or deleting a resource can cause an inconsistent state.LimitExceededException
- A limit is exceeded.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public UpdateTemplateAliasResult updateTemplateAlias(UpdateTemplateAliasRequest request)
Updates the template alias of a template.
updateTemplateAlias
in interface AmazonQuickSight
updateTemplateAliasRequest
- ThrottlingException
- Access is throttled.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- Updating or deleting a resource can cause an inconsistent state.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.ConflictException
- Updating or deleting a resource can cause an inconsistent state.InternalFailureException
- An internal failure occurred.public UpdateTemplatePermissionsResult updateTemplatePermissions(UpdateTemplatePermissionsRequest request)
Updates the resource permissions for a template.
updateTemplatePermissions
in interface AmazonQuickSight
updateTemplatePermissionsRequest
- ThrottlingException
- Access is throttled.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ConflictException
- Updating or deleting a resource can cause an inconsistent state.ResourceNotFoundException
- One or more resources can't be found.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public UpdateThemeResult updateTheme(UpdateThemeRequest request)
Updates a theme.
updateTheme
in interface AmazonQuickSight
updateThemeRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.LimitExceededException
- A limit is exceeded.ResourceExistsException
- The resource specified already exists.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public UpdateThemeAliasResult updateThemeAlias(UpdateThemeAliasRequest request)
Updates an alias of a theme.
updateThemeAlias
in interface AmazonQuickSight
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.public UpdateThemePermissionsResult updateThemePermissions(UpdateThemePermissionsRequest request)
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.
updateThemePermissions
in interface AmazonQuickSight
updateThemePermissionsRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.UnsupportedUserEditionException
- This error indicates that you are calling an operation on an Amazon QuickSight subscription where the
edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard
Edition and Enterprise Edition. Not every operation and capability is available in every edition.InternalFailureException
- An internal failure occurred.public UpdateUserResult updateUser(UpdateUserRequest request)
Updates an Amazon QuickSight user.
updateUser
in interface AmazonQuickSight
updateUserRequest
- AccessDeniedException
- You don't have access to this item. The provided credentials couldn't be validated. You might not be
authorized to carry out the request. Make sure that your account is authorized to use the Amazon
QuickSight service, that your policies have the correct permissions, and that you are using the correct
access keys.InvalidParameterValueException
- One or more parameters has a value that isn't valid.ResourceNotFoundException
- One or more resources can't be found.ThrottlingException
- Access is throttled.PreconditionNotMetException
- One or more preconditions aren't met.InternalFailureException
- An internal failure occurred.ResourceUnavailableException
- This resource is currently unavailable.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AmazonQuickSight
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonQuickSight
shutdown
in class AmazonWebServiceClient