@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 Amazon QuickSight customizations the current AWS 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.
|
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 all Amazon QuickSight customizations in this AWS Region for the specified AWS account and 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.
|
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 the provided AWS account and Amazon QuickSight namespace in an AWS
Region.
|
DescribeAccountSettingsResult |
describeAccountSettings(DescribeAccountSettingsRequest request)
Describes the settings that were used when your QuickSight subscription was first created in this AWS 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.
|
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 session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard
in your web server code.
|
GetSessionEmbedUrlResult |
getSessionEmbedUrl(GetSessionEmbedUrlRequest request)
Generates a session URL and authorization code that you can use to embed the Amazon QuickSight console in your
web server code.
|
ListAnalysesResult |
listAnalyses(ListAnalysesRequest request)
Lists Amazon QuickSight analyses that exist in the specified AWS account.
|
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.
|
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.
|
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 Amazon QuickSight customizations the current AWS Region.
|
UpdateAccountSettingsResult |
updateAccountSettings(UpdateAccountSettingsRequest request)
Updates the Amazon QuickSight settings in your AWS 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 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)
AmazonQuickSight
Cancels an ongoing ingestion of data into SPICE.
cancelIngestion
in interface AmazonQuickSight
public CreateAccountCustomizationResult createAccountCustomization(CreateAccountCustomizationRequest request)
AmazonQuickSight
Creates Amazon QuickSight customizations the current AWS Region. Currently, you can add a custom default theme by
using the CreateAccountCustomization
or UpdateAccountCustomization
API operation. To
further customize QuickSight by removing QuickSight sample assets and videos for all new users, see Customizing QuickSight
in the Amazon QuickSight User Guide.
You can create customizations for your AWS 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 AWS 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
public CreateAnalysisResult createAnalysis(CreateAnalysisRequest request)
AmazonQuickSight
Creates an analysis in Amazon QuickSight.
createAnalysis
in interface AmazonQuickSight
public CreateDashboardResult createDashboard(CreateDashboardRequest request)
AmazonQuickSight
Creates a dashboard from a template. To first create a template, see the CreateTemplate
API
operation.
A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account.
createDashboard
in interface AmazonQuickSight
public CreateDataSetResult createDataSet(CreateDataSetRequest request)
AmazonQuickSight
Creates a dataset.
createDataSet
in interface AmazonQuickSight
public CreateDataSourceResult createDataSource(CreateDataSourceRequest request)
AmazonQuickSight
Creates a data source.
createDataSource
in interface AmazonQuickSight
public CreateGroupResult createGroup(CreateGroupRequest request)
AmazonQuickSight
Creates an Amazon QuickSight group.
The permissions resource is
arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name>
.
The response is a group object.
createGroup
in interface AmazonQuickSight
request
- The request object for this operation.public CreateGroupMembershipResult createGroupMembership(CreateGroupMembershipRequest request)
AmazonQuickSight
Adds an Amazon QuickSight user to an Amazon QuickSight group.
createGroupMembership
in interface AmazonQuickSight
public CreateIAMPolicyAssignmentResult createIAMPolicyAssignment(CreateIAMPolicyAssignmentRequest request)
AmazonQuickSight
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 AWS account. To avoid overwriting rules in other namespaces, use assignment names that are unique.
createIAMPolicyAssignment
in interface AmazonQuickSight
public CreateIngestionResult createIngestion(CreateIngestionRequest request)
AmazonQuickSight
Creates and starts a new SPICE ingestion on a dataset
Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the AWS Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
createIngestion
in interface AmazonQuickSight
public 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 AmazonQuickSight
public CreateTemplateResult createTemplate(CreateTemplateRequest request)
AmazonQuickSight
Creates a template from an existing QuickSight analysis or template. You can use the resulting template to create a dashboard.
A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
createTemplate
in interface AmazonQuickSight
public CreateTemplateAliasResult createTemplateAlias(CreateTemplateAliasRequest request)
AmazonQuickSight
Creates a template alias for a template.
createTemplateAlias
in interface AmazonQuickSight
public CreateThemeResult createTheme(CreateThemeRequest request)
AmazonQuickSight
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
public CreateThemeAliasResult createThemeAlias(CreateThemeAliasRequest request)
AmazonQuickSight
Creates a theme alias for a theme.
createThemeAlias
in interface AmazonQuickSight
public DeleteAccountCustomizationResult deleteAccountCustomization(DeleteAccountCustomizationRequest request)
AmazonQuickSight
Deletes all Amazon QuickSight customizations in this AWS Region for the specified AWS account and QuickSight namespace.
deleteAccountCustomization
in interface AmazonQuickSight
public DeleteAnalysisResult deleteAnalysis(DeleteAnalysisRequest request)
AmazonQuickSight
Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can
restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. QuickSight
attaches a DeletionTime
stamp to the response that specifies the end of the recovery window. At the
end of the recovery window, QuickSight deletes the analysis permanently.
At any time before recovery window ends, you can use the RestoreAnalysis
API operation to remove the
DeletionTime
stamp and cancel the deletion of the analysis. The analysis remains visible in the API
until it's deleted, so you can describe it but you can't make a template from it.
An analysis that's scheduled for deletion isn't accessible in the QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
deleteAnalysis
in interface AmazonQuickSight
public DeleteDashboardResult deleteDashboard(DeleteDashboardRequest request)
AmazonQuickSight
Deletes a dashboard.
deleteDashboard
in interface AmazonQuickSight
public DeleteDataSetResult deleteDataSet(DeleteDataSetRequest request)
AmazonQuickSight
Deletes a dataset.
deleteDataSet
in interface AmazonQuickSight
public DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest request)
AmazonQuickSight
Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
deleteDataSource
in interface AmazonQuickSight
public DeleteGroupResult deleteGroup(DeleteGroupRequest request)
AmazonQuickSight
Removes a user group from Amazon QuickSight.
deleteGroup
in interface AmazonQuickSight
public DeleteGroupMembershipResult deleteGroupMembership(DeleteGroupMembershipRequest request)
AmazonQuickSight
Removes a user from a group so that the user is no longer a member of the group.
deleteGroupMembership
in interface AmazonQuickSight
public DeleteIAMPolicyAssignmentResult deleteIAMPolicyAssignment(DeleteIAMPolicyAssignmentRequest request)
AmazonQuickSight
Deletes an existing IAM policy assignment.
deleteIAMPolicyAssignment
in interface AmazonQuickSight
public DeleteNamespaceResult deleteNamespace(DeleteNamespaceRequest request)
AmazonQuickSight
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
public DeleteTemplateResult deleteTemplate(DeleteTemplateRequest request)
AmazonQuickSight
Deletes a template.
deleteTemplate
in interface AmazonQuickSight
public DeleteTemplateAliasResult deleteTemplateAlias(DeleteTemplateAliasRequest request)
AmazonQuickSight
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
public DeleteThemeResult deleteTheme(DeleteThemeRequest request)
AmazonQuickSight
Deletes a theme.
deleteTheme
in interface AmazonQuickSight
public DeleteThemeAliasResult deleteThemeAlias(DeleteThemeAliasRequest request)
AmazonQuickSight
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
public DeleteUserResult deleteUser(DeleteUserRequest request)
AmazonQuickSight
Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.
deleteUser
in interface AmazonQuickSight
public DeleteUserByPrincipalIdResult deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest request)
AmazonQuickSight
Deletes a user identified by its principal ID.
deleteUserByPrincipalId
in interface AmazonQuickSight
public DescribeAccountCustomizationResult describeAccountCustomization(DescribeAccountCustomizationRequest request)
AmazonQuickSight
Describes the customizations associated with the provided AWS account and Amazon QuickSight namespace in an AWS
Region. The QuickSight console evaluates which customizations to apply by running this API operation with the
Resolved
flag included.
To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.
AWS Account
- The AWS account exists at the top of the hierarchy. It has the potential to use all of
the AWS Regions and AWS Services. When you subscribe to QuickSight, you choose one AWS Region to use as your home
Region. That's where your free SPICE capacity is located. You can use QuickSight in any supported AWS Region.
AWS Region
- In each AWS Region where you sign in to QuickSight at least once, QuickSight acts as a
separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US
East (N. Virginia). Generally speaking, these users have access to QuickSight in any AWS Region, unless they are
constrained to a namespace.
To run the command in a different AWS Region, you change your Region settings. If you're using the AWS CLI, you can use one of the following options:
Use command line options.
Use named profiles.
Run aws configure
to change your default AWS Region. Use Enter to key the same settings for your
keys. For more information, see Configuring the AWS CLI.
Namespace
- A QuickSight namespace is a partition that contains users and assets (data sources,
datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also
be part of the same namespace. People who share a namespace are completely isolated from users and assets in
other namespaces, even if they are in the same AWS account and AWS Region.
Applied customizations
- Within an AWS Region, a set of QuickSight customizations can apply to an
AWS account or to a namespace. Settings that you apply to a namespace override settings that you apply to an AWS
account. All settings are isolated to a single AWS Region. To apply them in other AWS Regions, run the
CreateAccountCustomization
command in each AWS Region where you want to apply the same
customizations.
describeAccountCustomization
in interface AmazonQuickSight
public DescribeAccountSettingsResult describeAccountSettings(DescribeAccountSettingsRequest request)
AmazonQuickSight
Describes the settings that were used when your QuickSight subscription was first created in this AWS account.
describeAccountSettings
in interface AmazonQuickSight
public DescribeAnalysisResult describeAnalysis(DescribeAnalysisRequest request)
AmazonQuickSight
Provides a summary of the metadata for an analysis.
describeAnalysis
in interface AmazonQuickSight
public DescribeAnalysisPermissionsResult describeAnalysisPermissions(DescribeAnalysisPermissionsRequest request)
AmazonQuickSight
Provides the read and write permissions for an analysis.
describeAnalysisPermissions
in interface AmazonQuickSight
public DescribeDashboardResult describeDashboard(DescribeDashboardRequest request)
AmazonQuickSight
Provides a summary for a dashboard.
describeDashboard
in interface AmazonQuickSight
public DescribeDashboardPermissionsResult describeDashboardPermissions(DescribeDashboardPermissionsRequest request)
AmazonQuickSight
Describes read and write permissions for a dashboard.
describeDashboardPermissions
in interface AmazonQuickSight
public DescribeDataSetResult describeDataSet(DescribeDataSetRequest request)
AmazonQuickSight
Describes a dataset.
describeDataSet
in interface AmazonQuickSight
public DescribeDataSetPermissionsResult describeDataSetPermissions(DescribeDataSetPermissionsRequest request)
AmazonQuickSight
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
public DescribeDataSourceResult describeDataSource(DescribeDataSourceRequest request)
AmazonQuickSight
Describes a data source.
describeDataSource
in interface AmazonQuickSight
public DescribeDataSourcePermissionsResult describeDataSourcePermissions(DescribeDataSourcePermissionsRequest request)
AmazonQuickSight
Describes the resource permissions for a data source.
describeDataSourcePermissions
in interface AmazonQuickSight
public DescribeGroupResult describeGroup(DescribeGroupRequest request)
AmazonQuickSight
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
describeGroup
in interface AmazonQuickSight
public DescribeIAMPolicyAssignmentResult describeIAMPolicyAssignment(DescribeIAMPolicyAssignmentRequest request)
AmazonQuickSight
Describes an existing IAM policy assignment, as specified by the assignment name.
describeIAMPolicyAssignment
in interface AmazonQuickSight
public DescribeIngestionResult describeIngestion(DescribeIngestionRequest request)
AmazonQuickSight
Describes a SPICE ingestion.
describeIngestion
in interface AmazonQuickSight
public DescribeNamespaceResult describeNamespace(DescribeNamespaceRequest request)
AmazonQuickSight
Describes the current namespace.
describeNamespace
in interface AmazonQuickSight
public DescribeTemplateResult describeTemplate(DescribeTemplateRequest request)
AmazonQuickSight
Describes a template's metadata.
describeTemplate
in interface AmazonQuickSight
public DescribeTemplateAliasResult describeTemplateAlias(DescribeTemplateAliasRequest request)
AmazonQuickSight
Describes the template alias for a template.
describeTemplateAlias
in interface AmazonQuickSight
public DescribeTemplatePermissionsResult describeTemplatePermissions(DescribeTemplatePermissionsRequest request)
AmazonQuickSight
Describes read and write permissions on a template.
describeTemplatePermissions
in interface AmazonQuickSight
public DescribeThemeResult describeTheme(DescribeThemeRequest request)
AmazonQuickSight
Describes a theme.
describeTheme
in interface AmazonQuickSight
public DescribeThemeAliasResult describeThemeAlias(DescribeThemeAliasRequest request)
AmazonQuickSight
Describes the alias for a theme.
describeThemeAlias
in interface AmazonQuickSight
public DescribeThemePermissionsResult describeThemePermissions(DescribeThemePermissionsRequest request)
AmazonQuickSight
Describes the read and write permissions for a theme.
describeThemePermissions
in interface AmazonQuickSight
public DescribeUserResult describeUser(DescribeUserRequest request)
AmazonQuickSight
Returns information about a user, given the user name.
describeUser
in interface AmazonQuickSight
public GetDashboardEmbedUrlResult getDashboardEmbedUrl(GetDashboardEmbedUrlRequest request)
AmazonQuickSight
Generates a session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions.
Currently, you can use GetDashboardEmbedURL
only from the server, not from the user's browser. The
following rules apply to the combination of URL and authorization code:
They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
The resulting user session is valid for 10 hours.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
getDashboardEmbedUrl
in interface AmazonQuickSight
public GetSessionEmbedUrlResult getSessionEmbedUrl(GetSessionEmbedUrlRequest request)
AmazonQuickSight
Generates a session URL and authorization code that you can use to embed the Amazon QuickSight console in your
web server code. Use GetSessionEmbedUrl
where you want to provide an authoring portal that allows
users to create data sources, datasets, analyses, and dashboards. The users who access an embedded QuickSight
console need belong to the author or admin security cohort. If you want to restrict permissions to some of these
features, add a custom permissions profile to the user with the UpdateUser
API operation.
Use RegisterUser
API operation to add a new user with a custom permission profile attached.
For more information, see the following sections in the Amazon QuickSight User Guide:
getSessionEmbedUrl
in interface AmazonQuickSight
public ListAnalysesResult listAnalyses(ListAnalysesRequest request)
AmazonQuickSight
Lists Amazon QuickSight analyses that exist in the specified AWS account.
listAnalyses
in interface AmazonQuickSight
public ListDashboardVersionsResult listDashboardVersions(ListDashboardVersionsRequest request)
AmazonQuickSight
Lists all the versions of the dashboards in the QuickSight subscription.
listDashboardVersions
in interface AmazonQuickSight
public ListDashboardsResult listDashboards(ListDashboardsRequest request)
AmazonQuickSight
Lists dashboards in an AWS account.
listDashboards
in interface AmazonQuickSight
public ListDataSetsResult listDataSets(ListDataSetsRequest request)
AmazonQuickSight
Lists all of the datasets belonging to the current AWS account in an AWS Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*
.
listDataSets
in interface AmazonQuickSight
public ListDataSourcesResult listDataSources(ListDataSourcesRequest request)
AmazonQuickSight
Lists data sources in current AWS Region that belong to this AWS account.
listDataSources
in interface AmazonQuickSight
public ListGroupMembershipsResult listGroupMemberships(ListGroupMembershipsRequest request)
AmazonQuickSight
Lists member users in a group.
listGroupMemberships
in interface AmazonQuickSight
public ListGroupsResult listGroups(ListGroupsRequest request)
AmazonQuickSight
Lists all user groups in Amazon QuickSight.
listGroups
in interface AmazonQuickSight
public ListIAMPolicyAssignmentsResult listIAMPolicyAssignments(ListIAMPolicyAssignmentsRequest request)
AmazonQuickSight
Lists IAM policy assignments in the current Amazon QuickSight account.
listIAMPolicyAssignments
in interface AmazonQuickSight
public ListIAMPolicyAssignmentsForUserResult listIAMPolicyAssignmentsForUser(ListIAMPolicyAssignmentsForUserRequest request)
AmazonQuickSight
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
public ListIngestionsResult listIngestions(ListIngestionsRequest request)
AmazonQuickSight
Lists the history of SPICE ingestions for a dataset.
listIngestions
in interface AmazonQuickSight
public ListNamespacesResult listNamespaces(ListNamespacesRequest request)
AmazonQuickSight
Lists the namespaces for the specified AWS account.
listNamespaces
in interface AmazonQuickSight
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonQuickSight
Lists the tags assigned to a resource.
listTagsForResource
in interface AmazonQuickSight
public ListTemplateAliasesResult listTemplateAliases(ListTemplateAliasesRequest request)
AmazonQuickSight
Lists all the aliases of a template.
listTemplateAliases
in interface AmazonQuickSight
public ListTemplateVersionsResult listTemplateVersions(ListTemplateVersionsRequest request)
AmazonQuickSight
Lists all the versions of the templates in the current Amazon QuickSight account.
listTemplateVersions
in interface AmazonQuickSight
public ListTemplatesResult listTemplates(ListTemplatesRequest request)
AmazonQuickSight
Lists all the templates in the current Amazon QuickSight account.
listTemplates
in interface AmazonQuickSight
public ListThemeAliasesResult listThemeAliases(ListThemeAliasesRequest request)
AmazonQuickSight
Lists all the aliases of a theme.
listThemeAliases
in interface AmazonQuickSight
public ListThemeVersionsResult listThemeVersions(ListThemeVersionsRequest request)
AmazonQuickSight
Lists all the versions of the themes in the current AWS account.
listThemeVersions
in interface AmazonQuickSight
public ListThemesResult listThemes(ListThemesRequest request)
AmazonQuickSight
Lists all the themes in the current AWS account.
listThemes
in interface AmazonQuickSight
public ListUserGroupsResult listUserGroups(ListUserGroupsRequest request)
AmazonQuickSight
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
listUserGroups
in interface AmazonQuickSight
public ListUsersResult listUsers(ListUsersRequest request)
AmazonQuickSight
Returns a list of all of the Amazon QuickSight users belonging to this account.
listUsers
in interface AmazonQuickSight
public RegisterUserResult registerUser(RegisterUserRequest request)
AmazonQuickSight
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
registerUser
in interface AmazonQuickSight
public RestoreAnalysisResult restoreAnalysis(RestoreAnalysisRequest request)
AmazonQuickSight
Restores an analysis.
restoreAnalysis
in interface AmazonQuickSight
public SearchAnalysesResult searchAnalyses(SearchAnalysesRequest request)
AmazonQuickSight
Searches for analyses that belong to the user specified in the filter.
searchAnalyses
in interface AmazonQuickSight
public SearchDashboardsResult searchDashboards(SearchDashboardsRequest request)
AmazonQuickSight
Searches for dashboards that belong to a user.
searchDashboards
in interface AmazonQuickSight
public TagResourceResult tagResource(TagResourceRequest request)
AmazonQuickSight
Assigns one or more tags (key-value pairs) to the specified QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by
granting a user permission to access or change only resources with certain tag values. You can use the
TagResource
operation with a resource that already has tags. If you specify a new tag key for the
resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is
already associated with the resource, the new tag value that you specify replaces the previous value for that
tag.
You can associate as many as 50 tags with a resource. QuickSight supports tagging on data set, data source, dashboard, and template.
Tagging for QuickSight works in a similar way to tagging for other AWS services, except for the following:
You can't use tags to track AWS costs for QuickSight. This restriction is because QuickSight costs are based on users and SPICE capacity, which aren't taggable resources.
QuickSight doesn't currently support the Tag Editor for AWS Resource Groups.
tagResource
in interface AmazonQuickSight
public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonQuickSight
Removes a tag or tags from a resource.
untagResource
in interface AmazonQuickSight
public UpdateAccountCustomizationResult updateAccountCustomization(UpdateAccountCustomizationRequest request)
AmazonQuickSight
Updates Amazon QuickSight customizations the current AWS Region. Currently, the only customization you can use is a theme.
You can use customizations for your AWS account or, if you specify a namespace, for a QuickSight namespace
instead. Customizations that apply to a namespace override customizations that apply to an AWS account. To find
out which customizations apply, use the DescribeAccountCustomization
API operation.
updateAccountCustomization
in interface AmazonQuickSight
public UpdateAccountSettingsResult updateAccountSettings(UpdateAccountSettingsRequest request)
AmazonQuickSight
Updates the Amazon QuickSight settings in your AWS account.
updateAccountSettings
in interface AmazonQuickSight
public UpdateAnalysisResult updateAnalysis(UpdateAnalysisRequest request)
AmazonQuickSight
Updates an analysis in Amazon QuickSight
updateAnalysis
in interface AmazonQuickSight
public UpdateAnalysisPermissionsResult updateAnalysisPermissions(UpdateAnalysisPermissionsRequest request)
AmazonQuickSight
Updates the read and write permissions for an analysis.
updateAnalysisPermissions
in interface AmazonQuickSight
public UpdateDashboardResult updateDashboard(UpdateDashboardRequest request)
AmazonQuickSight
Updates a dashboard in an AWS account.
updateDashboard
in interface AmazonQuickSight
public UpdateDashboardPermissionsResult updateDashboardPermissions(UpdateDashboardPermissionsRequest request)
AmazonQuickSight
Updates read and write permissions on a dashboard.
updateDashboardPermissions
in interface AmazonQuickSight
public UpdateDashboardPublishedVersionResult updateDashboardPublishedVersion(UpdateDashboardPublishedVersionRequest request)
AmazonQuickSight
Updates the published version of a dashboard.
updateDashboardPublishedVersion
in interface AmazonQuickSight
public UpdateDataSetResult updateDataSet(UpdateDataSetRequest request)
AmazonQuickSight
Updates a dataset.
updateDataSet
in interface AmazonQuickSight
public UpdateDataSetPermissionsResult updateDataSetPermissions(UpdateDataSetPermissionsRequest request)
AmazonQuickSight
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
public UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest request)
AmazonQuickSight
Updates a data source.
updateDataSource
in interface AmazonQuickSight
public UpdateDataSourcePermissionsResult updateDataSourcePermissions(UpdateDataSourcePermissionsRequest request)
AmazonQuickSight
Updates the permissions to a data source.
updateDataSourcePermissions
in interface AmazonQuickSight
public UpdateGroupResult updateGroup(UpdateGroupRequest request)
AmazonQuickSight
Changes a group description.
updateGroup
in interface AmazonQuickSight
public UpdateIAMPolicyAssignmentResult updateIAMPolicyAssignment(UpdateIAMPolicyAssignmentRequest request)
AmazonQuickSight
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
public UpdateTemplateResult updateTemplate(UpdateTemplateRequest request)
AmazonQuickSight
Updates a template from an existing Amazon QuickSight analysis or another template.
updateTemplate
in interface AmazonQuickSight
public UpdateTemplateAliasResult updateTemplateAlias(UpdateTemplateAliasRequest request)
AmazonQuickSight
Updates the template alias of a template.
updateTemplateAlias
in interface AmazonQuickSight
public UpdateTemplatePermissionsResult updateTemplatePermissions(UpdateTemplatePermissionsRequest request)
AmazonQuickSight
Updates the resource permissions for a template.
updateTemplatePermissions
in interface AmazonQuickSight
public UpdateThemeResult updateTheme(UpdateThemeRequest request)
AmazonQuickSight
Updates a theme.
updateTheme
in interface AmazonQuickSight
public UpdateThemeAliasResult updateThemeAlias(UpdateThemeAliasRequest request)
AmazonQuickSight
Updates an alias of a theme.
updateThemeAlias
in interface AmazonQuickSight
public 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 AmazonQuickSight
public UpdateUserResult updateUser(UpdateUserRequest request)
AmazonQuickSight
Updates an Amazon QuickSight user.
updateUser
in interface AmazonQuickSight
public void shutdown()
AmazonQuickSight
shutdown
in interface AmazonQuickSight
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonQuickSight
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AmazonQuickSight
request
- The originally executed request.