@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonQuickSight extends Object implements AmazonQuickSight
AmazonQuickSight. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
CancelIngestionResult |
cancelIngestion(CancelIngestionRequest request)
Cancels an ongoing ingestion of data into SPICE.
|
CreateAccountCustomizationResult |
createAccountCustomization(CreateAccountCustomizationRequest request)
Creates a customization for the Amazon QuickSight subscription associated with your AWS account.
|
CreateDashboardResult |
createDashboard(CreateDashboardRequest request)
Creates a dashboard from a template.
|
CreateDataSetResult |
createDataSet(CreateDataSetRequest request)
Creates a dataset.
|
CreateDataSourceResult |
createDataSource(CreateDataSourceRequest request)
Creates a data source.
|
CreateGroupResult |
createGroup(CreateGroupRequest request)
Creates an Amazon QuickSight group.
|
CreateGroupMembershipResult |
createGroupMembership(CreateGroupMembershipRequest request)
Adds an Amazon QuickSight user to an Amazon QuickSight group.
|
CreateIAMPolicyAssignmentResult |
createIAMPolicyAssignment(CreateIAMPolicyAssignmentRequest request)
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN).
|
CreateIngestionResult |
createIngestion(CreateIngestionRequest request)
Creates and starts a new SPICE ingestion on a dataset
|
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 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 customizations for the QuickSight subscription on your AWS account.
|
DeleteDashboardResult |
deleteDashboard(DeleteDashboardRequest request)
Deletes a dashboard.
|
DeleteDataSetResult |
deleteDataSet(DeleteDataSetRequest request)
Deletes a dataset.
|
DeleteDataSourceResult |
deleteDataSource(DeleteDataSourceRequest request)
Deletes the data source permanently.
|
DeleteGroupResult |
deleteGroup(DeleteGroupRequest request)
Removes a user group from Amazon QuickSight.
|
DeleteGroupMembershipResult |
deleteGroupMembership(DeleteGroupMembershipRequest request)
Removes a user from a group so that the user is no longer a member of the group.
|
DeleteIAMPolicyAssignmentResult |
deleteIAMPolicyAssignment(DeleteIAMPolicyAssignmentRequest request)
Deletes an existing IAM policy assignment.
|
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 AWS Identity and Access Management
(IAM) user or role that's making the call.
|
DeleteUserByPrincipalIdResult |
deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest request)
Deletes a user identified by its principal ID.
|
DescribeAccountCustomizationResult |
describeAccountCustomization(DescribeAccountCustomizationRequest request)
Describes the customizations associated with your AWS account.
|
DescribeAccountSettingsResult |
describeAccountSettings(DescribeAccountSettingsRequest request)
Describes the settings that were used when your QuickSight subscription was first created in this AWS Account.
|
DescribeDashboardResult |
describeDashboard(DescribeDashboardRequest request)
Provides a summary for a dashboard.
|
DescribeDashboardPermissionsResult |
describeDashboardPermissions(DescribeDashboardPermissionsRequest request)
Describes read and write permissions for a dashboard.
|
DescribeDataSetResult |
describeDataSet(DescribeDataSetRequest request)
Describes a dataset.
|
DescribeDataSetPermissionsResult |
describeDataSetPermissions(DescribeDataSetPermissionsRequest request)
Describes the permissions on a dataset.
|
DescribeDataSourceResult |
describeDataSource(DescribeDataSourceRequest request)
Describes a data source.
|
DescribeDataSourcePermissionsResult |
describeDataSourcePermissions(DescribeDataSourcePermissionsRequest request)
Describes the resource permissions for a data source.
|
DescribeGroupResult |
describeGroup(DescribeGroupRequest request)
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
|
DescribeIAMPolicyAssignmentResult |
describeIAMPolicyAssignment(DescribeIAMPolicyAssignmentRequest request)
Describes an existing IAM policy assignment, as specified by the assignment name.
|
DescribeIngestionResult |
describeIngestion(DescribeIngestionRequest request)
Describes a SPICE ingestion.
|
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.
|
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 URL and authorization code that you can embed in your web server code.
|
GetSessionEmbedUrlResult |
getSessionEmbedUrl(GetSessionEmbedUrlRequest request)
Generates a session URL and authorization code that you can embed in your web server code.
|
ListDashboardsResult |
listDashboards(ListDashboardsRequest request)
Lists dashboards in an AWS account.
|
ListDashboardVersionsResult |
listDashboardVersions(ListDashboardVersionsRequest request)
Lists all the versions of the dashboards in the QuickSight subscription.
|
ListDataSetsResult |
listDataSets(ListDataSetsRequest request)
Lists all of the datasets belonging to the current AWS account in an AWS Region.
|
ListDataSourcesResult |
listDataSources(ListDataSourcesRequest request)
Lists data sources in current AWS Region that belong to this AWS account.
|
ListGroupMembershipsResult |
listGroupMemberships(ListGroupMembershipsRequest request)
Lists member users in a group.
|
ListGroupsResult |
listGroups(ListGroupsRequest request)
Lists all user groups in Amazon QuickSight.
|
ListIAMPolicyAssignmentsResult |
listIAMPolicyAssignments(ListIAMPolicyAssignmentsRequest request)
Lists IAM policy assignments in the current Amazon QuickSight account.
|
ListIAMPolicyAssignmentsForUserResult |
listIAMPolicyAssignmentsForUser(ListIAMPolicyAssignmentsForUserRequest request)
Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to
the specified user and group or groups that the user belongs to.
|
ListIngestionsResult |
listIngestions(ListIngestionsRequest request)
Lists the history of SPICE ingestions for a dataset.
|
ListNamespacesResult |
listNamespaces(ListNamespacesRequest request)
Lists the namespaces for the specified AWS 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 AWS account.
|
ListThemeVersionsResult |
listThemeVersions(ListThemeVersionsRequest request)
Lists all the versions of the themes in the current AWS account.
|
ListUserGroupsResult |
listUserGroups(ListUserGroupsRequest request)
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
|
ListUsersResult |
listUsers(ListUsersRequest request)
Returns a list of all of the Amazon QuickSight users belonging to this account.
|
RegisterUserResult |
registerUser(RegisterUserRequest request)
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM)
identity or role specified in the request.
|
SearchDashboardsResult |
searchDashboards(SearchDashboardsRequest request)
Searchs for dashboards that belong to a user.
|
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 QuickSight resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes a tag or tags from a resource.
|
UpdateAccountCustomizationResult |
updateAccountCustomization(UpdateAccountCustomizationRequest request)
Updates customizations associated with the QuickSight subscription on your AWS account.
|
UpdateAccountSettingsResult |
updateAccountSettings(UpdateAccountSettingsRequest request)
Updates the settings for the Amazon QuickSight subscription in your AWS Account.
|
UpdateDashboardResult |
updateDashboard(UpdateDashboardRequest request)
Updates a dashboard in an AWS account.
|
UpdateDashboardPermissionsResult |
updateDashboardPermissions(UpdateDashboardPermissionsRequest request)
Updates read and write permissions on a dashboard.
|
UpdateDashboardPublishedVersionResult |
updateDashboardPublishedVersion(UpdateDashboardPublishedVersionRequest request)
Updates the published version of a dashboard.
|
UpdateDataSetResult |
updateDataSet(UpdateDataSetRequest request)
Updates a dataset.
|
UpdateDataSetPermissionsResult |
updateDataSetPermissions(UpdateDataSetPermissionsRequest request)
Updates the permissions on a dataset.
|
UpdateDataSourceResult |
updateDataSource(UpdateDataSourceRequest request)
Updates a data source.
|
UpdateDataSourcePermissionsResult |
updateDataSourcePermissions(UpdateDataSourcePermissionsRequest request)
Updates the permissions to a data source.
|
UpdateGroupResult |
updateGroup(UpdateGroupRequest request)
Changes a group description.
|
UpdateIAMPolicyAssignmentResult |
updateIAMPolicyAssignment(UpdateIAMPolicyAssignmentRequest request)
Updates an existing IAM policy assignment.
|
UpdateTemplateResult |
updateTemplate(UpdateTemplateRequest request)
Updates a template from an existing Amazon QuickSight analysis or another template.
|
UpdateTemplateAliasResult |
updateTemplateAlias(UpdateTemplateAliasRequest request)
Updates the template alias of a template.
|
UpdateTemplatePermissionsResult |
updateTemplatePermissions(UpdateTemplatePermissionsRequest request)
Updates the resource permissions for a template.
|
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.
|
public CancelIngestionResult cancelIngestion(CancelIngestionRequest request)
AmazonQuickSightCancels an ongoing ingestion of data into SPICE.
cancelIngestion in interface AmazonQuickSightpublic CreateAccountCustomizationResult createAccountCustomization(CreateAccountCustomizationRequest request)
AmazonQuickSightCreates a customization for the Amazon QuickSight subscription associated with your AWS account.
createAccountCustomization in interface AmazonQuickSightpublic CreateDashboardResult createDashboard(CreateDashboardRequest request)
AmazonQuickSightCreates a dashboard from a template. To first create a template, see the CreateTemplate API operation.
A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share
QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. The
CreateDashboard, DescribeDashboard, and ListDashboardsByUser API
operations act on the dashboard entity. If you have the correct permissions, you can create a dashboard from a
template that exists in a different AWS account.
createDashboard in interface AmazonQuickSightpublic CreateDataSetResult createDataSet(CreateDataSetRequest request)
AmazonQuickSightCreates a dataset.
createDataSet in interface AmazonQuickSightpublic CreateDataSourceResult createDataSource(CreateDataSourceRequest request)
AmazonQuickSightCreates a data source.
createDataSource in interface AmazonQuickSightpublic CreateGroupResult createGroup(CreateGroupRequest request)
AmazonQuickSightCreates an Amazon QuickSight group.
The permissions resource is
arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name>
.
The response is a group object.
createGroup in interface AmazonQuickSightrequest - The request object for this operation.public CreateGroupMembershipResult createGroupMembership(CreateGroupMembershipRequest request)
AmazonQuickSightAdds an Amazon QuickSight user to an Amazon QuickSight group.
createGroupMembership in interface AmazonQuickSightpublic CreateIAMPolicyAssignmentResult createIAMPolicyAssignment(CreateIAMPolicyAssignmentRequest request)
AmazonQuickSightCreates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy will be assigned to specified groups or users of Amazon QuickSight. The users and groups need to be in the same namespace.
createIAMPolicyAssignment in interface AmazonQuickSightpublic CreateIngestionResult createIngestion(CreateIngestionRequest request)
AmazonQuickSightCreates and starts a new SPICE ingestion on a dataset
Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the AWS Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
createIngestion in interface AmazonQuickSightpublic CreateNamespaceResult createNamespace(CreateNamespaceRequest request)
AmazonQuickSight(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
A namespace allows you to isolate the QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your AWS account is subscribed to QuickSight. The namespace must be unique within the AWS account. By default, there is a limit of 100 namespaces per AWS account. To increase your limit, create a ticket with AWS Support.
createNamespace in interface AmazonQuickSightpublic CreateTemplateResult createTemplate(CreateTemplateRequest request)
AmazonQuickSightCreates a template from an existing QuickSight analysis or template. You can use the resulting template to create a dashboard.
A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
createTemplate in interface AmazonQuickSightpublic CreateTemplateAliasResult createTemplateAlias(CreateTemplateAliasRequest request)
AmazonQuickSightCreates a template alias for a template.
createTemplateAlias in interface AmazonQuickSightpublic CreateThemeResult createTheme(CreateThemeRequest request)
AmazonQuickSightCreates 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 AmazonQuickSightpublic CreateThemeAliasResult createThemeAlias(CreateThemeAliasRequest request)
AmazonQuickSightCreates a theme alias for a theme.
createThemeAlias in interface AmazonQuickSightpublic DeleteAccountCustomizationResult deleteAccountCustomization(DeleteAccountCustomizationRequest request)
AmazonQuickSightDeletes customizations for the QuickSight subscription on your AWS account.
deleteAccountCustomization in interface AmazonQuickSightpublic DeleteDashboardResult deleteDashboard(DeleteDashboardRequest request)
AmazonQuickSightDeletes a dashboard.
deleteDashboard in interface AmazonQuickSightpublic DeleteDataSetResult deleteDataSet(DeleteDataSetRequest request)
AmazonQuickSightDeletes a dataset.
deleteDataSet in interface AmazonQuickSightpublic DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest request)
AmazonQuickSightDeletes the data source permanently. This action breaks all the datasets that reference the deleted data source.
deleteDataSource in interface AmazonQuickSightpublic DeleteGroupResult deleteGroup(DeleteGroupRequest request)
AmazonQuickSightRemoves a user group from Amazon QuickSight.
deleteGroup in interface AmazonQuickSightpublic DeleteGroupMembershipResult deleteGroupMembership(DeleteGroupMembershipRequest request)
AmazonQuickSightRemoves a user from a group so that the user is no longer a member of the group.
deleteGroupMembership in interface AmazonQuickSightpublic DeleteIAMPolicyAssignmentResult deleteIAMPolicyAssignment(DeleteIAMPolicyAssignmentRequest request)
AmazonQuickSightDeletes an existing IAM policy assignment.
deleteIAMPolicyAssignment in interface AmazonQuickSightpublic DeleteNamespaceResult deleteNamespace(DeleteNamespaceRequest request)
AmazonQuickSightDeletes 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 APIs for the relevant asset.
deleteNamespace in interface AmazonQuickSightpublic DeleteTemplateResult deleteTemplate(DeleteTemplateRequest request)
AmazonQuickSightDeletes a template.
deleteTemplate in interface AmazonQuickSightpublic DeleteTemplateAliasResult deleteTemplateAlias(DeleteTemplateAliasRequest request)
AmazonQuickSightDeletes 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 AmazonQuickSightpublic DeleteThemeResult deleteTheme(DeleteThemeRequest request)
AmazonQuickSightDeletes a theme.
deleteTheme in interface AmazonQuickSightpublic DeleteThemeAliasResult deleteThemeAlias(DeleteThemeAliasRequest request)
AmazonQuickSightDeletes 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 AmazonQuickSightpublic DeleteUserResult deleteUser(DeleteUserRequest request)
AmazonQuickSightDeletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.
deleteUser in interface AmazonQuickSightpublic DeleteUserByPrincipalIdResult deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest request)
AmazonQuickSightDeletes a user identified by its principal ID.
deleteUserByPrincipalId in interface AmazonQuickSightpublic DescribeAccountCustomizationResult describeAccountCustomization(DescribeAccountCustomizationRequest request)
AmazonQuickSightDescribes the customizations associated with your AWS account.
describeAccountCustomization in interface AmazonQuickSightpublic DescribeAccountSettingsResult describeAccountSettings(DescribeAccountSettingsRequest request)
AmazonQuickSightDescribes the settings that were used when your QuickSight subscription was first created in this AWS Account.
describeAccountSettings in interface AmazonQuickSightpublic DescribeDashboardResult describeDashboard(DescribeDashboardRequest request)
AmazonQuickSightProvides a summary for a dashboard.
describeDashboard in interface AmazonQuickSightpublic DescribeDashboardPermissionsResult describeDashboardPermissions(DescribeDashboardPermissionsRequest request)
AmazonQuickSightDescribes read and write permissions for a dashboard.
describeDashboardPermissions in interface AmazonQuickSightpublic DescribeDataSetResult describeDataSet(DescribeDataSetRequest request)
AmazonQuickSightDescribes a dataset.
describeDataSet in interface AmazonQuickSightpublic DescribeDataSetPermissionsResult describeDataSetPermissions(DescribeDataSetPermissionsRequest request)
AmazonQuickSightDescribes the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
describeDataSetPermissions in interface AmazonQuickSightpublic DescribeDataSourceResult describeDataSource(DescribeDataSourceRequest request)
AmazonQuickSightDescribes a data source.
describeDataSource in interface AmazonQuickSightpublic DescribeDataSourcePermissionsResult describeDataSourcePermissions(DescribeDataSourcePermissionsRequest request)
AmazonQuickSightDescribes the resource permissions for a data source.
describeDataSourcePermissions in interface AmazonQuickSightpublic DescribeGroupResult describeGroup(DescribeGroupRequest request)
AmazonQuickSightReturns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
describeGroup in interface AmazonQuickSightpublic DescribeIAMPolicyAssignmentResult describeIAMPolicyAssignment(DescribeIAMPolicyAssignmentRequest request)
AmazonQuickSightDescribes an existing IAM policy assignment, as specified by the assignment name.
describeIAMPolicyAssignment in interface AmazonQuickSightpublic DescribeIngestionResult describeIngestion(DescribeIngestionRequest request)
AmazonQuickSightDescribes a SPICE ingestion.
describeIngestion in interface AmazonQuickSightpublic DescribeNamespaceResult describeNamespace(DescribeNamespaceRequest request)
AmazonQuickSightDescribes the current namespace.
describeNamespace in interface AmazonQuickSightpublic DescribeTemplateResult describeTemplate(DescribeTemplateRequest request)
AmazonQuickSightDescribes a template's metadata.
describeTemplate in interface AmazonQuickSightpublic DescribeTemplateAliasResult describeTemplateAlias(DescribeTemplateAliasRequest request)
AmazonQuickSightDescribes the template alias for a template.
describeTemplateAlias in interface AmazonQuickSightpublic DescribeTemplatePermissionsResult describeTemplatePermissions(DescribeTemplatePermissionsRequest request)
AmazonQuickSightDescribes read and write permissions on a template.
describeTemplatePermissions in interface AmazonQuickSightpublic DescribeThemeResult describeTheme(DescribeThemeRequest request)
AmazonQuickSightDescribes a theme.
describeTheme in interface AmazonQuickSightpublic DescribeThemeAliasResult describeThemeAlias(DescribeThemeAliasRequest request)
AmazonQuickSightDescribes the alias for a theme.
describeThemeAlias in interface AmazonQuickSightpublic DescribeThemePermissionsResult describeThemePermissions(DescribeThemePermissionsRequest request)
AmazonQuickSightDescribes the read and write permissions for a theme.
describeThemePermissions in interface AmazonQuickSightpublic DescribeUserResult describeUser(DescribeUserRequest request)
AmazonQuickSightReturns information about a user, given the user name.
describeUser in interface AmazonQuickSightpublic GetDashboardEmbedUrlResult getDashboardEmbedUrl(GetDashboardEmbedUrlRequest request)
AmazonQuickSightGenerates a URL and authorization code that you can embed 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 Amazon QuickSight Dashboards in the Amazon QuickSight User Guide or Embedding Amazon QuickSight Dashboards in the Amazon QuickSight API Reference.
getDashboardEmbedUrl in interface AmazonQuickSightpublic GetSessionEmbedUrlResult getSessionEmbedUrl(GetSessionEmbedUrlRequest request)
AmazonQuickSightGenerates a session URL and authorization code that you can embed in your web server code.
getSessionEmbedUrl in interface AmazonQuickSightpublic ListDashboardVersionsResult listDashboardVersions(ListDashboardVersionsRequest request)
AmazonQuickSightLists all the versions of the dashboards in the QuickSight subscription.
listDashboardVersions in interface AmazonQuickSightpublic ListDashboardsResult listDashboards(ListDashboardsRequest request)
AmazonQuickSightLists dashboards in an AWS account.
listDashboards in interface AmazonQuickSightpublic ListDataSetsResult listDataSets(ListDataSetsRequest request)
AmazonQuickSightLists all of the datasets belonging to the current AWS account in an AWS Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
listDataSets in interface AmazonQuickSightpublic ListDataSourcesResult listDataSources(ListDataSourcesRequest request)
AmazonQuickSightLists data sources in current AWS Region that belong to this AWS account.
listDataSources in interface AmazonQuickSightpublic ListGroupMembershipsResult listGroupMemberships(ListGroupMembershipsRequest request)
AmazonQuickSightLists member users in a group.
listGroupMemberships in interface AmazonQuickSightpublic ListGroupsResult listGroups(ListGroupsRequest request)
AmazonQuickSightLists all user groups in Amazon QuickSight.
listGroups in interface AmazonQuickSightpublic ListIAMPolicyAssignmentsResult listIAMPolicyAssignments(ListIAMPolicyAssignmentsRequest request)
AmazonQuickSightLists IAM policy assignments in the current Amazon QuickSight account.
listIAMPolicyAssignments in interface AmazonQuickSightpublic ListIAMPolicyAssignmentsForUserResult listIAMPolicyAssignmentsForUser(ListIAMPolicyAssignmentsForUserRequest request)
AmazonQuickSightLists 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 AmazonQuickSightpublic ListIngestionsResult listIngestions(ListIngestionsRequest request)
AmazonQuickSightLists the history of SPICE ingestions for a dataset.
listIngestions in interface AmazonQuickSightpublic ListNamespacesResult listNamespaces(ListNamespacesRequest request)
AmazonQuickSightLists the namespaces for the specified AWS account.
listNamespaces in interface AmazonQuickSightpublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonQuickSightLists the tags assigned to a resource.
listTagsForResource in interface AmazonQuickSightpublic ListTemplateAliasesResult listTemplateAliases(ListTemplateAliasesRequest request)
AmazonQuickSightLists all the aliases of a template.
listTemplateAliases in interface AmazonQuickSightpublic ListTemplateVersionsResult listTemplateVersions(ListTemplateVersionsRequest request)
AmazonQuickSightLists all the versions of the templates in the current Amazon QuickSight account.
listTemplateVersions in interface AmazonQuickSightpublic ListTemplatesResult listTemplates(ListTemplatesRequest request)
AmazonQuickSightLists all the templates in the current Amazon QuickSight account.
listTemplates in interface AmazonQuickSightpublic ListThemeAliasesResult listThemeAliases(ListThemeAliasesRequest request)
AmazonQuickSightLists all the aliases of a theme.
listThemeAliases in interface AmazonQuickSightpublic ListThemeVersionsResult listThemeVersions(ListThemeVersionsRequest request)
AmazonQuickSightLists all the versions of the themes in the current AWS account.
listThemeVersions in interface AmazonQuickSightpublic ListThemesResult listThemes(ListThemesRequest request)
AmazonQuickSightLists all the themes in the current AWS account.
listThemes in interface AmazonQuickSightpublic ListUserGroupsResult listUserGroups(ListUserGroupsRequest request)
AmazonQuickSightLists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
listUserGroups in interface AmazonQuickSightpublic ListUsersResult listUsers(ListUsersRequest request)
AmazonQuickSightReturns a list of all of the Amazon QuickSight users belonging to this account.
listUsers in interface AmazonQuickSightpublic RegisterUserResult registerUser(RegisterUserRequest request)
AmazonQuickSightCreates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
registerUser in interface AmazonQuickSightpublic SearchDashboardsResult searchDashboards(SearchDashboardsRequest request)
AmazonQuickSightSearchs for dashboards that belong to a user.
searchDashboards in interface AmazonQuickSightpublic TagResourceResult tagResource(TagResourceRequest request)
AmazonQuickSightAssigns one or more tags (key-value pairs) to the specified QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by
granting a user permission to access or change only resources with certain tag values. You can use the
TagResource operation with a resource that already has tags. If you specify a new tag key for the
resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is
already associated with the resource, the new tag value that you specify replaces the previous value for that
tag.
You can associate as many as 50 tags with a resource. QuickSight supports tagging on data set, data source, dashboard, and template.
Tagging for QuickSight works in a similar way to tagging for other AWS services, except for the following:
You can't use tags to track AWS costs for QuickSight. This restriction is because QuickSight costs are based on users and SPICE capacity, which aren't taggable resources.
QuickSight doesn't currently support the Tag Editor for AWS Resource Groups.
tagResource in interface AmazonQuickSightpublic UntagResourceResult untagResource(UntagResourceRequest request)
AmazonQuickSightRemoves a tag or tags from a resource.
untagResource in interface AmazonQuickSightpublic UpdateAccountCustomizationResult updateAccountCustomization(UpdateAccountCustomizationRequest request)
AmazonQuickSightUpdates customizations associated with the QuickSight subscription on your AWS account.
updateAccountCustomization in interface AmazonQuickSightpublic UpdateAccountSettingsResult updateAccountSettings(UpdateAccountSettingsRequest request)
AmazonQuickSightUpdates the settings for the Amazon QuickSight subscription in your AWS Account.
updateAccountSettings in interface AmazonQuickSightpublic UpdateDashboardResult updateDashboard(UpdateDashboardRequest request)
AmazonQuickSightUpdates a dashboard in an AWS account.
updateDashboard in interface AmazonQuickSightpublic UpdateDashboardPermissionsResult updateDashboardPermissions(UpdateDashboardPermissionsRequest request)
AmazonQuickSightUpdates read and write permissions on a dashboard.
updateDashboardPermissions in interface AmazonQuickSightpublic UpdateDashboardPublishedVersionResult updateDashboardPublishedVersion(UpdateDashboardPublishedVersionRequest request)
AmazonQuickSightUpdates the published version of a dashboard.
updateDashboardPublishedVersion in interface AmazonQuickSightpublic UpdateDataSetResult updateDataSet(UpdateDataSetRequest request)
AmazonQuickSightUpdates a dataset.
updateDataSet in interface AmazonQuickSightpublic UpdateDataSetPermissionsResult updateDataSetPermissions(UpdateDataSetPermissionsRequest request)
AmazonQuickSightUpdates the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
updateDataSetPermissions in interface AmazonQuickSightpublic UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest request)
AmazonQuickSightUpdates a data source.
updateDataSource in interface AmazonQuickSightpublic UpdateDataSourcePermissionsResult updateDataSourcePermissions(UpdateDataSourcePermissionsRequest request)
AmazonQuickSightUpdates the permissions to a data source.
updateDataSourcePermissions in interface AmazonQuickSightpublic UpdateGroupResult updateGroup(UpdateGroupRequest request)
AmazonQuickSightChanges a group description.
updateGroup in interface AmazonQuickSightpublic UpdateIAMPolicyAssignmentResult updateIAMPolicyAssignment(UpdateIAMPolicyAssignmentRequest request)
AmazonQuickSightUpdates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request.
updateIAMPolicyAssignment in interface AmazonQuickSightpublic UpdateTemplateResult updateTemplate(UpdateTemplateRequest request)
AmazonQuickSightUpdates a template from an existing Amazon QuickSight analysis or another template.
updateTemplate in interface AmazonQuickSightpublic UpdateTemplateAliasResult updateTemplateAlias(UpdateTemplateAliasRequest request)
AmazonQuickSightUpdates the template alias of a template.
updateTemplateAlias in interface AmazonQuickSightpublic UpdateTemplatePermissionsResult updateTemplatePermissions(UpdateTemplatePermissionsRequest request)
AmazonQuickSightUpdates the resource permissions for a template.
updateTemplatePermissions in interface AmazonQuickSightpublic UpdateThemeResult updateTheme(UpdateThemeRequest request)
AmazonQuickSightUpdates a theme.
updateTheme in interface AmazonQuickSightpublic UpdateThemeAliasResult updateThemeAlias(UpdateThemeAliasRequest request)
AmazonQuickSightUpdates an alias of a theme.
updateThemeAlias in interface AmazonQuickSightpublic UpdateThemePermissionsResult updateThemePermissions(UpdateThemePermissionsRequest request)
AmazonQuickSight
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 AmazonQuickSightpublic UpdateUserResult updateUser(UpdateUserRequest request)
AmazonQuickSightUpdates an Amazon QuickSight user.
updateUser in interface AmazonQuickSightpublic void shutdown()
AmazonQuickSightshutdown in interface AmazonQuickSightpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonQuickSightResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AmazonQuickSightrequest - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.