@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
public BatchCreateTopicReviewedAnswerResult batchCreateTopicReviewedAnswer(BatchCreateTopicReviewedAnswerRequest request)
AmazonQuickSight
Creates new reviewed answers for a Q Topic.
batchCreateTopicReviewedAnswer
in interface AmazonQuickSight
public BatchDeleteTopicReviewedAnswerResult batchDeleteTopicReviewedAnswer(BatchDeleteTopicReviewedAnswerRequest request)
AmazonQuickSight
Deletes reviewed answers for Q Topic.
batchDeleteTopicReviewedAnswer
in interface AmazonQuickSight
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 for the current Amazon Web Services Region. Currently, you can add a
custom default theme by using the CreateAccountCustomization
or
UpdateAccountCustomization
API operation. To further customize Amazon QuickSight by removing Amazon
QuickSight sample assets and videos for all new users, see Customizing Amazon
QuickSight in the Amazon QuickSight User Guide.
You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a
QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply
to an Amazon Web Services account. To find out which customizations apply, use the
DescribeAccountCustomization
API operation.
Before you use the CreateAccountCustomization
API operation to add a theme as the namespace default,
make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme
isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the
current permissions by using the
DescribeThemePermissions
API operation. To share the theme, grant permissions by using the
UpdateThemePermissions
API operation.
createAccountCustomization
in interface AmazonQuickSight
public CreateAccountSubscriptionResult createAccountSubscription(CreateAccountSubscriptionRequest request)
AmazonQuickSight
Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.
The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK.
Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon QuickSight User Guide. The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon QuickSight in the Amazon QuickSight User Guide.
If your IAM policy includes both the Subscribe
and CreateAccountSubscription
actions,
make sure that both actions are set to Allow
. If either action is set to Deny
, the
Deny
action prevails and your API call fails.
You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the Amazon QuickSight User Guide.
You can't set default resource access on the new account from the Amazon QuickSight API. Instead, add default resource access from the Amazon QuickSight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon QuickSight User Guide.
createAccountSubscription
in interface AmazonQuickSight
public CreateAnalysisResult createAnalysis(CreateAnalysisRequest request)
AmazonQuickSight
Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an
AnalysisDefinition
.
createAnalysis
in interface AmazonQuickSight
public CreateDashboardResult createDashboard(CreateDashboardRequest request)
AmazonQuickSight
Creates a dashboard from either a template or directly with a DashboardDefinition
. To first create a
template, see the
CreateTemplate
API operation.
A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
createDashboard
in interface AmazonQuickSight
public CreateDataSetResult createDataSet(CreateDataSetRequest request)
AmazonQuickSight
Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
createDataSet
in interface AmazonQuickSight
public CreateDataSourceResult createDataSource(CreateDataSourceRequest request)
AmazonQuickSight
Creates a data source.
createDataSource
in interface AmazonQuickSight
public CreateFolderResult createFolder(CreateFolderRequest request)
AmazonQuickSight
Creates an empty shared folder.
createFolder
in interface AmazonQuickSight
public CreateFolderMembershipResult createFolderMembership(CreateFolderMembershipRequest request)
AmazonQuickSight
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
createFolderMembership
in interface AmazonQuickSight
public CreateGroupResult createGroup(CreateGroupRequest request)
AmazonQuickSight
Use the CreateGroup
operation to create a group in Amazon QuickSight. You can create up to 10,000
groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact Amazon Web Services
Support.
The permissions resource is
arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name>
.
The response is a group object.
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 Amazon Web Services 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 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
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 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
public CreateRefreshScheduleResult createRefreshSchedule(CreateRefreshScheduleRequest request)
AmazonQuickSight
Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
createRefreshSchedule
in interface AmazonQuickSight
public CreateRoleMembershipResult createRoleMembership(CreateRoleMembershipRequest request)
AmazonQuickSight
Use CreateRoleMembership
to add an existing Amazon QuickSight group to an existing role.
createRoleMembership
in interface AmazonQuickSight
public CreateTemplateResult createTemplate(CreateTemplateRequest request)
AmazonQuickSight
Creates a template either from a TemplateDefinition
or from an existing Amazon QuickSight analysis
or template. You can use the resulting template to create additional dashboards, templates, or analyses.
A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
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 CreateTopicResult createTopic(CreateTopicRequest request)
AmazonQuickSight
Creates a new Q topic.
createTopic
in interface AmazonQuickSight
public CreateTopicRefreshScheduleResult createTopicRefreshSchedule(CreateTopicRefreshScheduleRequest request)
AmazonQuickSight
Creates a topic refresh schedule.
createTopicRefreshSchedule
in interface AmazonQuickSight
public CreateVPCConnectionResult createVPCConnection(CreateVPCConnectionRequest request)
AmazonQuickSight
Creates a new VPC connection.
createVPCConnection
in interface AmazonQuickSight
public DeleteAccountCustomizationResult deleteAccountCustomization(DeleteAccountCustomizationRequest request)
AmazonQuickSight
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
public DeleteAccountSubscriptionResult deleteAccountSubscription(DeleteAccountSubscriptionRequest request)
AmazonQuickSight
Use the DeleteAccountSubscription
operation to delete an Amazon QuickSight account. This operation
will result in an error message if you have configured your account termination protection settings to
True
. To change this setting and delete your account, call the UpdateAccountSettings
API and set the value of the TerminationProtectionEnabled
parameter to False
, then make
another call to the DeleteAccountSubscription
API.
deleteAccountSubscription
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. 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
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 DeleteDataSetRefreshPropertiesResult deleteDataSetRefreshProperties(DeleteDataSetRefreshPropertiesRequest request)
AmazonQuickSight
Deletes the dataset refresh properties of the dataset.
deleteDataSetRefreshProperties
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 DeleteFolderResult deleteFolder(DeleteFolderRequest request)
AmazonQuickSight
Deletes an empty folder.
deleteFolder
in interface AmazonQuickSight
public DeleteFolderMembershipResult deleteFolderMembership(DeleteFolderMembershipRequest request)
AmazonQuickSight
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
deleteFolderMembership
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 DeleteIdentityPropagationConfigResult deleteIdentityPropagationConfig(DeleteIdentityPropagationConfigRequest request)
AmazonQuickSight
Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application.
This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.
deleteIdentityPropagationConfig
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 DeleteRefreshScheduleResult deleteRefreshSchedule(DeleteRefreshScheduleRequest request)
AmazonQuickSight
Deletes a refresh schedule from a dataset.
deleteRefreshSchedule
in interface AmazonQuickSight
public DeleteRoleCustomPermissionResult deleteRoleCustomPermission(DeleteRoleCustomPermissionRequest request)
AmazonQuickSight
Removes custom permissions from the role.
deleteRoleCustomPermission
in interface AmazonQuickSight
public DeleteRoleMembershipResult deleteRoleMembership(DeleteRoleMembershipRequest request)
AmazonQuickSight
Removes a group from a role.
deleteRoleMembership
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 DeleteTopicResult deleteTopic(DeleteTopicRequest request)
AmazonQuickSight
Deletes a topic.
deleteTopic
in interface AmazonQuickSight
public DeleteTopicRefreshScheduleResult deleteTopicRefreshSchedule(DeleteTopicRefreshScheduleRequest request)
AmazonQuickSight
Deletes a topic refresh schedule.
deleteTopicRefreshSchedule
in interface AmazonQuickSight
public DeleteUserResult deleteUser(DeleteUserRequest request)
AmazonQuickSight
Deletes the Amazon QuickSight user that is associated with the identity of the IAM user or role that's making the call. The IAM user isn't deleted as a result of this call.
deleteUser
in interface AmazonQuickSight
public DeleteUserByPrincipalIdResult deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest request)
AmazonQuickSight
Deletes a user identified by its principal ID.
deleteUserByPrincipalId
in interface AmazonQuickSight
public DeleteVPCConnectionResult deleteVPCConnection(DeleteVPCConnectionRequest request)
AmazonQuickSight
Deletes a VPC connection.
deleteVPCConnection
in interface AmazonQuickSight
public DescribeAccountCustomizationResult describeAccountCustomization(DescribeAccountCustomizationRequest request)
AmazonQuickSight
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
public DescribeAccountSettingsResult describeAccountSettings(DescribeAccountSettingsRequest request)
AmazonQuickSight
Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
describeAccountSettings
in interface AmazonQuickSight
public DescribeAccountSubscriptionResult describeAccountSubscription(DescribeAccountSubscriptionRequest request)
AmazonQuickSight
Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's
subscription. A successful API call returns an AccountInfo
object that includes an account's name,
subscription status, authentication type, edition, and notification email address.
describeAccountSubscription
in interface AmazonQuickSight
public DescribeAnalysisResult describeAnalysis(DescribeAnalysisRequest request)
AmazonQuickSight
Provides a summary of the metadata for an analysis.
describeAnalysis
in interface AmazonQuickSight
public DescribeAnalysisDefinitionResult describeAnalysisDefinition(DescribeAnalysisDefinitionRequest request)
AmazonQuickSight
Provides a detailed description of the definition of an analysis.
If you do not need to know details about the content of an Analysis, for instance if you are trying to check the
status of a recently created or updated Analysis, use the
DescribeAnalysis
instead.
describeAnalysisDefinition
in interface AmazonQuickSight
public DescribeAnalysisPermissionsResult describeAnalysisPermissions(DescribeAnalysisPermissionsRequest request)
AmazonQuickSight
Provides the read and write permissions for an analysis.
describeAnalysisPermissions
in interface AmazonQuickSight
public DescribeAssetBundleExportJobResult describeAssetBundleExportJob(DescribeAssetBundleExportJobRequest request)
AmazonQuickSight
Describes an existing export job.
Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to
download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You
can call the DescribeAssetBundleExportJob
API for a new download URL as needed.
Job descriptions are available for 14 days after the job starts.
describeAssetBundleExportJob
in interface AmazonQuickSight
public DescribeAssetBundleImportJobResult describeAssetBundleImportJob(DescribeAssetBundleImportJobRequest request)
AmazonQuickSight
Describes an existing import job.
Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.
describeAssetBundleImportJob
in interface AmazonQuickSight
public DescribeDashboardResult describeDashboard(DescribeDashboardRequest request)
AmazonQuickSight
Provides a summary for a dashboard.
describeDashboard
in interface AmazonQuickSight
public DescribeDashboardDefinitionResult describeDashboardDefinition(DescribeDashboardDefinitionRequest request)
AmazonQuickSight
Provides a detailed description of the definition of a dashboard.
If you do not need to know details about the content of a dashboard, for instance if you are trying to check the
status of a recently created or updated dashboard, use the
DescribeDashboard
instead.
describeDashboardDefinition
in interface AmazonQuickSight
public DescribeDashboardPermissionsResult describeDashboardPermissions(DescribeDashboardPermissionsRequest request)
AmazonQuickSight
Describes read and write permissions for a dashboard.
describeDashboardPermissions
in interface AmazonQuickSight
public DescribeDashboardSnapshotJobResult describeDashboardSnapshotJob(DescribeDashboardSnapshotJobRequest request)
AmazonQuickSight
Describes an existing snapshot job.
Poll job descriptions after a job starts to know the status of the job. For information on available status
codes, see JobStatus
.
describeDashboardSnapshotJob
in interface AmazonQuickSight
public DescribeDashboardSnapshotJobResultResult describeDashboardSnapshotJobResult(DescribeDashboardSnapshotJobResultRequest request)
AmazonQuickSight
Describes the result of an existing snapshot job that has finished running.
A finished snapshot job will return a COMPLETED
or FAILED
status when you poll the job
with a DescribeDashboardSnapshotJob
API call.
If the job has not finished running, this operation returns a message that says
Dashboard Snapshot Job with id <SnapshotjobId> has not reached a terminal state.
.
describeDashboardSnapshotJobResult
in interface AmazonQuickSight
public DescribeDataSetResult describeDataSet(DescribeDataSetRequest request)
AmazonQuickSight
Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.
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 DescribeDataSetRefreshPropertiesResult describeDataSetRefreshProperties(DescribeDataSetRefreshPropertiesRequest request)
AmazonQuickSight
Describes the refresh properties of a dataset.
describeDataSetRefreshProperties
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 DescribeFolderResult describeFolder(DescribeFolderRequest request)
AmazonQuickSight
Describes a folder.
describeFolder
in interface AmazonQuickSight
public DescribeFolderPermissionsResult describeFolderPermissions(DescribeFolderPermissionsRequest request)
AmazonQuickSight
Describes permissions for a folder.
describeFolderPermissions
in interface AmazonQuickSight
public DescribeFolderResolvedPermissionsResult describeFolderResolvedPermissions(DescribeFolderResolvedPermissionsRequest request)
AmazonQuickSight
Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
describeFolderResolvedPermissions
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 DescribeGroupMembershipResult describeGroupMembership(DescribeGroupMembershipRequest request)
AmazonQuickSight
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
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 DescribeIpRestrictionResult describeIpRestriction(DescribeIpRestrictionRequest request)
AmazonQuickSight
Provides a summary and status of IP rules.
describeIpRestriction
in interface AmazonQuickSight
public DescribeKeyRegistrationResult describeKeyRegistration(DescribeKeyRegistrationRequest request)
AmazonQuickSight
Describes all customer managed key registrations in a Amazon QuickSight account.
describeKeyRegistration
in interface AmazonQuickSight
public DescribeNamespaceResult describeNamespace(DescribeNamespaceRequest request)
AmazonQuickSight
Describes the current namespace.
describeNamespace
in interface AmazonQuickSight
public DescribeRefreshScheduleResult describeRefreshSchedule(DescribeRefreshScheduleRequest request)
AmazonQuickSight
Provides a summary of a refresh schedule.
describeRefreshSchedule
in interface AmazonQuickSight
public DescribeRoleCustomPermissionResult describeRoleCustomPermission(DescribeRoleCustomPermissionRequest request)
AmazonQuickSight
Describes all custom permissions that are mapped to a role.
describeRoleCustomPermission
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 DescribeTemplateDefinitionResult describeTemplateDefinition(DescribeTemplateDefinitionRequest request)
AmazonQuickSight
Provides a detailed description of the definition of a template.
If you do not need to know details about the content of a template, for instance if you are trying to check the
status of a recently created or updated template, use the
DescribeTemplate
instead.
describeTemplateDefinition
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 DescribeTopicResult describeTopic(DescribeTopicRequest request)
AmazonQuickSight
Describes a topic.
describeTopic
in interface AmazonQuickSight
public DescribeTopicPermissionsResult describeTopicPermissions(DescribeTopicPermissionsRequest request)
AmazonQuickSight
Describes the permissions of a topic.
describeTopicPermissions
in interface AmazonQuickSight
public DescribeTopicRefreshResult describeTopicRefresh(DescribeTopicRefreshRequest request)
AmazonQuickSight
Describes the status of a topic refresh.
describeTopicRefresh
in interface AmazonQuickSight
public DescribeTopicRefreshScheduleResult describeTopicRefreshSchedule(DescribeTopicRefreshScheduleRequest request)
AmazonQuickSight
Deletes a topic refresh schedule.
describeTopicRefreshSchedule
in interface AmazonQuickSight
public DescribeUserResult describeUser(DescribeUserRequest request)
AmazonQuickSight
Returns information about a user, given the user name.
describeUser
in interface AmazonQuickSight
public DescribeVPCConnectionResult describeVPCConnection(DescribeVPCConnectionRequest request)
AmazonQuickSight
Describes a VPC connection.
describeVPCConnection
in interface AmazonQuickSight
public GenerateEmbedUrlForAnonymousUserResult generateEmbedUrlForAnonymousUser(GenerateEmbedUrlForAnonymousUserRequest request)
AmazonQuickSight
Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutes
parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default
session duration is 10 hours.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
generateEmbedUrlForAnonymousUser
in interface AmazonQuickSight
public GenerateEmbedUrlForRegisteredUserResult generateEmbedUrlForRegisteredUser(GenerateEmbedUrlForRegisteredUserRequest request)
AmazonQuickSight
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
public GetDashboardEmbedUrlResult getDashboardEmbedUrl(GetDashboardEmbedUrlRequest request)
AmazonQuickSight
Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions.
Currently, you can use GetDashboardEmbedURL
only from the server, not from the user's browser. The
following rules apply to the generated URL:
They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional
SessionLifetimeInMinutes
parameter to customize session duration.
For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
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 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
public ListAnalysesResult listAnalyses(ListAnalysesRequest request)
AmazonQuickSight
Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
listAnalyses
in interface AmazonQuickSight
public ListAssetBundleExportJobsResult listAssetBundleExportJobs(ListAssetBundleExportJobsRequest request)
AmazonQuickSight
Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days
ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs,
ListAssetBundleExportJobs
only returns the most recent job that uses the repeated job ID.
listAssetBundleExportJobs
in interface AmazonQuickSight
public ListAssetBundleImportJobsResult listAssetBundleImportJobs(ListAssetBundleImportJobsRequest request)
AmazonQuickSight
Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago
are deleted forever and are not returned. If you are using the same job ID for multiple jobs,
ListAssetBundleImportJobs
only returns the most recent job that uses the repeated job ID.
listAssetBundleImportJobs
in interface AmazonQuickSight
public ListDashboardVersionsResult listDashboardVersions(ListDashboardVersionsRequest request)
AmazonQuickSight
Lists all the versions of the dashboards in the Amazon QuickSight subscription.
listDashboardVersions
in interface AmazonQuickSight
public ListDashboardsResult listDashboards(ListDashboardsRequest request)
AmazonQuickSight
Lists dashboards in an Amazon Web Services account.
listDashboards
in interface AmazonQuickSight
public ListDataSetsResult listDataSets(ListDataSetsRequest request)
AmazonQuickSight
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
public ListDataSourcesResult listDataSources(ListDataSourcesRequest request)
AmazonQuickSight
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
listDataSources
in interface AmazonQuickSight
public ListFolderMembersResult listFolderMembers(ListFolderMembersRequest request)
AmazonQuickSight
List all assets (DASHBOARD
, ANALYSIS
, and DATASET
) in a folder.
listFolderMembers
in interface AmazonQuickSight
public ListFoldersResult listFolders(ListFoldersRequest request)
AmazonQuickSight
Lists all folders in an account.
listFolders
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 the IAM policy assignments in the current Amazon QuickSight account.
listIAMPolicyAssignments
in interface AmazonQuickSight
public ListIAMPolicyAssignmentsForUserResult listIAMPolicyAssignmentsForUser(ListIAMPolicyAssignmentsForUserRequest request)
AmazonQuickSight
Lists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to.
listIAMPolicyAssignmentsForUser
in interface AmazonQuickSight
public ListIdentityPropagationConfigsResult listIdentityPropagationConfigs(ListIdentityPropagationConfigsRequest request)
AmazonQuickSight
Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access.
This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.
listIdentityPropagationConfigs
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 Amazon Web Services account. This operation doesn't list deleted namespaces.
listNamespaces
in interface AmazonQuickSight
public ListRefreshSchedulesResult listRefreshSchedules(ListRefreshSchedulesRequest request)
AmazonQuickSight
Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.
listRefreshSchedules
in interface AmazonQuickSight
public ListRoleMembershipsResult listRoleMemberships(ListRoleMembershipsRequest request)
AmazonQuickSight
Lists all groups that are associated with a role.
listRoleMemberships
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 Amazon Web Services account.
listThemeVersions
in interface AmazonQuickSight
public ListThemesResult listThemes(ListThemesRequest request)
AmazonQuickSight
Lists all the themes in the current Amazon Web Services account.
listThemes
in interface AmazonQuickSight
public ListTopicRefreshSchedulesResult listTopicRefreshSchedules(ListTopicRefreshSchedulesRequest request)
AmazonQuickSight
Lists all of the refresh schedules for a topic.
listTopicRefreshSchedules
in interface AmazonQuickSight
public ListTopicReviewedAnswersResult listTopicReviewedAnswers(ListTopicReviewedAnswersRequest request)
AmazonQuickSight
Lists all reviewed answers for a Q Topic.
listTopicReviewedAnswers
in interface AmazonQuickSight
public ListTopicsResult listTopics(ListTopicsRequest request)
AmazonQuickSight
Lists all of the topics within an account.
listTopics
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 ListVPCConnectionsResult listVPCConnections(ListVPCConnectionsRequest request)
AmazonQuickSight
Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
listVPCConnections
in interface AmazonQuickSight
public PutDataSetRefreshPropertiesResult putDataSetRefreshProperties(PutDataSetRefreshPropertiesRequest request)
AmazonQuickSight
Creates or updates the dataset refresh properties for the dataset.
putDataSetRefreshProperties
in interface AmazonQuickSight
public RegisterUserResult registerUser(RegisterUserRequest request)
AmazonQuickSight
Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see Inviting users to access Amazon QuickSight.
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.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
searchAnalyses
in interface AmazonQuickSight
public SearchDashboardsResult searchDashboards(SearchDashboardsRequest request)
AmazonQuickSight
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
public SearchDataSetsResult searchDataSets(SearchDataSetsRequest request)
AmazonQuickSight
Use the SearchDataSets
operation to search for datasets that belong to an account.
searchDataSets
in interface AmazonQuickSight
public SearchDataSourcesResult searchDataSources(SearchDataSourcesRequest request)
AmazonQuickSight
Use the SearchDataSources
operation to search for data sources that belong to an account.
searchDataSources
in interface AmazonQuickSight
public SearchFoldersResult searchFolders(SearchFoldersRequest request)
AmazonQuickSight
Searches the subfolders in a folder.
searchFolders
in interface AmazonQuickSight
public SearchGroupsResult searchGroups(SearchGroupsRequest request)
AmazonQuickSight
Use the SearchGroups
operation to search groups in a specified Amazon QuickSight namespace using the
supplied filters.
searchGroups
in interface AmazonQuickSight
public StartAssetBundleExportJobResult startAssetBundleExportJob(StartAssetBundleExportJobRequest request)
AmazonQuickSight
Starts an Asset Bundle export job.
An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset
dependencies in the same job. Export jobs run asynchronously and can be polled with a
DescribeAssetBundleExportJob
API call. When a job is successfully completed, a download URL that
contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a
DescribeAssetBundleExportJob
API call. Each Amazon QuickSight account can run up to 5 export jobs
concurrently.
The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
startAssetBundleExportJob
in interface AmazonQuickSight
public StartAssetBundleImportJobResult startAssetBundleImportJob(StartAssetBundleImportJobRequest request)
AmazonQuickSight
Starts an Asset Bundle import job.
An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently.
The API caller must have the necessary "create"
, "describe"
, and "update"
permissions in their IAM role to access each resource type that is contained in the bundle file before the
resources can be imported.
startAssetBundleImportJob
in interface AmazonQuickSight
public StartDashboardSnapshotJobResult startDashboardSnapshotJob(StartDashboardSnapshotJobRequest request)
AmazonQuickSight
Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.
1 Paginated PDF
1 Excel workbook that includes up to 5 table or pivot table visuals
5 CSVs from table or pivot table visuals
The status of a submitted job can be polled with the DescribeDashboardSnapshotJob
API. When you call
the DescribeDashboardSnapshotJob
API, check the JobStatus
field in the response. Once
the job reaches a COMPLETED
or FAILED
status, use the
DescribeDashboardSnapshotJobResult
API to obtain the URLs for the generated files. If the job fails,
the DescribeDashboardSnapshotJobResult
API returns detailed information about the error that
occurred.
StartDashboardSnapshotJob API throttling
Amazon QuickSight utilizes API throttling to create a more consistent user experience within a time span for
customers when they call the StartDashboardSnapshotJob
. By default, 12 jobs can run simlutaneously
in one Amazon Web Services account and users can submit up 10 API requests per second before an account is
throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Amazon
QuickSight throttles the API calls to maintin an optimal experience and reliability for all Amazon QuickSight
users.
Common throttling scenarios
The following list provides information about the most commin throttling scenarios that can occur.
A large number of SnapshotExport
API jobs are running simultaneously on an Amazon Web Services
account. When a new StartDashboardSnapshotJob
is created and there are already 12 jobs with the
RUNNING
status, the new job request fails and returns a LimitExceededException
error.
Wait for a current job to comlpete before you resubmit the new job.
A large number of API requests are submitted on an Amazon Web Services account. When a user makes more
than 10 API calls to the Amazon QuickSight API in one second, a ThrottlingException
is returned.
If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account.
Best practices to handle throttling
If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of
API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for
the total processing time of your projected load that stays within the throttling limits of the Amazon QuickSight
APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in
parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply
the duration by 9, for example (12 minutes * 9 = 108 minutes)
. Use the new result to determine the
latest time at which the jobs need to be started to meet your target deadline.
The time that it takes to process a job can be impacted by the following factors:
The dataset type (Direct Query or SPICE).
The size of the dataset.
The complexity of the calculated fields that are used in the dashboard.
The number of visuals that are on a sheet.
The types of visuals that are on the sheet.
The number of formats and snapshots that are requested in the job configuration.
The size of the generated snapshots.
startDashboardSnapshotJob
in interface AmazonQuickSight
public TagResourceResult tagResource(TagResourceRequest request)
AmazonQuickSight
Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by
granting a user permission to access or change only resources with certain tag values. You can use the
TagResource
operation with a resource that already has tags. If you specify a new tag key for the
resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is
already associated with the resource, the new tag value that you specify replaces the previous value for that
tag.
You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, template, topic, and user.
Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following:
Tags are used to track costs for users in Amazon QuickSight. You can't tag other resources that Amazon QuickSight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units.
Amazon QuickSight doesn't currently support the tag editor for Resource Groups.
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 for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.
You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon
QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an
Amazon Web Services account. To find out which customizations apply, use the
DescribeAccountCustomization
API operation.
updateAccountCustomization
in interface AmazonQuickSight
public UpdateAccountSettingsResult updateAccountSettings(UpdateAccountSettingsRequest request)
AmazonQuickSight
Updates the Amazon QuickSight settings in your Amazon Web Services 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 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
public UpdateDashboardLinksResult updateDashboardLinks(UpdateDashboardLinksRequest request)
AmazonQuickSight
Updates the linked analyses on a dashboard.
updateDashboardLinks
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. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.
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 UpdateFolderResult updateFolder(UpdateFolderRequest request)
AmazonQuickSight
Updates the name of a folder.
updateFolder
in interface AmazonQuickSight
public UpdateFolderPermissionsResult updateFolderPermissions(UpdateFolderPermissionsRequest request)
AmazonQuickSight
Updates permissions of a folder.
updateFolderPermissions
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 UpdateIdentityPropagationConfigResult updateIdentityPropagationConfig(UpdateIdentityPropagationConfigRequest request)
AmazonQuickSight
Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access.
This operation is only supported for Amazon QuickSight accounts using IAM Identity Center
updateIdentityPropagationConfig
in interface AmazonQuickSight
public UpdateIpRestrictionResult updateIpRestriction(UpdateIpRestrictionRequest request)
AmazonQuickSight
Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the
IpRestrictionRule
, VpcIdRestrictionRule
, or VpcEndpointIdRestrictionRule
.
To use this operation, you must provide the entire map of rules. You can use the
DescribeIpRestriction
operation to get the current rule map.
updateIpRestriction
in interface AmazonQuickSight
public UpdateKeyRegistrationResult updateKeyRegistration(UpdateKeyRegistrationRequest request)
AmazonQuickSight
Updates a customer managed key in a Amazon QuickSight account.
updateKeyRegistration
in interface AmazonQuickSight
public UpdatePublicSharingSettingsResult updatePublicSharingSettings(UpdatePublicSharingSettingsRequest request)
AmazonQuickSight
Use the UpdatePublicSharingSettings
operation to turn on or turn off the public sharing settings of
an Amazon QuickSight dashboard.
To use this operation, turn on session capacity pricing for your Amazon QuickSight account.
Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon QuickSight, see Using Amazon QuickSight with IAM in the Amazon QuickSight User Guide.
updatePublicSharingSettings
in interface AmazonQuickSight
public UpdateRefreshScheduleResult updateRefreshSchedule(UpdateRefreshScheduleRequest request)
AmazonQuickSight
Updates a refresh schedule for a dataset.
updateRefreshSchedule
in interface AmazonQuickSight
public UpdateRoleCustomPermissionResult updateRoleCustomPermission(UpdateRoleCustomPermissionRequest request)
AmazonQuickSight
Updates the custom permissions that are associated with a role.
updateRoleCustomPermission
in interface AmazonQuickSight
public UpdateSPICECapacityConfigurationResult updateSPICECapacityConfiguration(UpdateSPICECapacityConfigurationRequest request)
AmazonQuickSight
Updates the SPICE capacity configuration for a Amazon QuickSight account.
updateSPICECapacityConfiguration
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 UpdateTopicResult updateTopic(UpdateTopicRequest request)
AmazonQuickSight
Updates a topic.
updateTopic
in interface AmazonQuickSight
public UpdateTopicPermissionsResult updateTopicPermissions(UpdateTopicPermissionsRequest request)
AmazonQuickSight
Updates the permissions of a topic.
updateTopicPermissions
in interface AmazonQuickSight
public UpdateTopicRefreshScheduleResult updateTopicRefreshSchedule(UpdateTopicRefreshScheduleRequest request)
AmazonQuickSight
Updates a topic refresh schedule.
updateTopicRefreshSchedule
in interface AmazonQuickSight
public UpdateUserResult updateUser(UpdateUserRequest request)
AmazonQuickSight
Updates an Amazon QuickSight user.
updateUser
in interface AmazonQuickSight
public UpdateVPCConnectionResult updateVPCConnection(UpdateVPCConnectionRequest request)
AmazonQuickSight
Updates a VPC connection.
updateVPCConnection
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.