Class: AWS.QuickSight
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.QuickSight
- Identifier:
- quicksight
- API Version:
- 2018-04-01
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
Amazon QuickSight is a fully managed, serverless business intelligence service for the Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.
Sending a Request Using QuickSight
var quicksight = new AWS.QuickSight();
quicksight.batchCreateTopicReviewedAnswer(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the QuickSight object uses this specific API, you can
construct the object by passing the apiVersion option to the constructor:
var quicksight = new AWS.QuickSight({apiVersion: '2018-04-01'});
You can also set the API version globally in AWS.config.apiVersions using
the quicksight service identifier:
AWS.config.apiVersions = {
quicksight: '2018-04-01',
// other service API versions
};
var quicksight = new AWS.QuickSight();
Constructor Summary collapse
-
new AWS.QuickSight(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
batchCreateTopicReviewedAnswer(params = {}, callback) ⇒ AWS.Request
Creates new reviewed answers for a Q Topic.
.
-
batchDeleteTopicReviewedAnswer(params = {}, callback) ⇒ AWS.Request
Deletes reviewed answers for Q Topic.
.
-
cancelIngestion(params = {}, callback) ⇒ AWS.Request
Cancels an ongoing ingestion of data into SPICE.
.
-
createAccountCustomization(params = {}, callback) ⇒ AWS.Request
Creates Amazon QuickSight customizations for the current Amazon Web Services Region.
-
createAccountSubscription(params = {}, callback) ⇒ AWS.Request
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.
-
createAnalysis(params = {}, callback) ⇒ AWS.Request
Creates an analysis in Amazon QuickSight.
-
createDashboard(params = {}, callback) ⇒ AWS.Request
Creates a dashboard from either a template or directly with a
DashboardDefinition. -
createDataSet(params = {}, callback) ⇒ AWS.Request
Creates a dataset.
-
createDataSource(params = {}, callback) ⇒ AWS.Request
Creates a data source.
.
-
createFolder(params = {}, callback) ⇒ AWS.Request
Creates an empty shared folder.
.
-
createFolderMembership(params = {}, callback) ⇒ AWS.Request
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
.
-
createGroup(params = {}, callback) ⇒ AWS.Request
Use the
CreateGroupoperation to create a group in Amazon QuickSight. -
createGroupMembership(params = {}, callback) ⇒ AWS.Request
Adds an Amazon QuickSight user to an Amazon QuickSight group.
-
createIAMPolicyAssignment(params = {}, callback) ⇒ AWS.Request
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN).
-
createIngestion(params = {}, callback) ⇒ AWS.Request
Creates and starts a new SPICE ingestion for a dataset.
-
createNamespace(params = {}, callback) ⇒ AWS.Request
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
A namespace allows you to isolate the Amazon QuickSight users and groups that are registered for that namespace.
-
createRefreshSchedule(params = {}, callback) ⇒ AWS.Request
Creates a refresh schedule for a dataset.
-
createRoleMembership(params = {}, callback) ⇒ AWS.Request
Use
CreateRoleMembershipto add an existing Amazon QuickSight group to an existing role..
-
createTemplate(params = {}, callback) ⇒ AWS.Request
Creates a template either from a
TemplateDefinitionor from an existing Amazon QuickSight analysis or template. -
createTemplateAlias(params = {}, callback) ⇒ AWS.Request
Creates a template alias for a template.
.
-
createTheme(params = {}, callback) ⇒ AWS.Request
Creates a theme.
A theme is set of configuration options for color and layout.
-
createThemeAlias(params = {}, callback) ⇒ AWS.Request
Creates a theme alias for a theme.
.
-
createTopic(params = {}, callback) ⇒ AWS.Request
Creates a new Q topic.
.
-
createTopicRefreshSchedule(params = {}, callback) ⇒ AWS.Request
Creates a topic refresh schedule.
.
-
createVPCConnection(params = {}, callback) ⇒ AWS.Request
Creates a new VPC connection.
.
-
deleteAccountCustomization(params = {}, callback) ⇒ AWS.Request
Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.
.
-
deleteAccountSubscription(params = {}, callback) ⇒ AWS.Request
Use the
DeleteAccountSubscriptionoperation to delete an Amazon QuickSight account. -
deleteAnalysis(params = {}, callback) ⇒ AWS.Request
Deletes an analysis from Amazon QuickSight.
-
deleteDashboard(params = {}, callback) ⇒ AWS.Request
Deletes a dashboard.
.
-
deleteDataSet(params = {}, callback) ⇒ AWS.Request
Deletes a dataset.
.
-
deleteDataSetRefreshProperties(params = {}, callback) ⇒ AWS.Request
Deletes the dataset refresh properties of the dataset.
.
-
deleteDataSource(params = {}, callback) ⇒ AWS.Request
Deletes the data source permanently.
-
deleteFolder(params = {}, callback) ⇒ AWS.Request
Deletes an empty folder.
.
-
deleteFolderMembership(params = {}, callback) ⇒ AWS.Request
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
.
-
deleteGroup(params = {}, callback) ⇒ AWS.Request
Removes a user group from Amazon QuickSight.
-
deleteGroupMembership(params = {}, callback) ⇒ AWS.Request
Removes a user from a group so that the user is no longer a member of the group.
.
-
deleteIAMPolicyAssignment(params = {}, callback) ⇒ AWS.Request
Deletes an existing IAM policy assignment.
.
-
deleteIdentityPropagationConfig(params = {}, callback) ⇒ AWS.Request
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.
. -
deleteNamespace(params = {}, callback) ⇒ AWS.Request
Deletes a namespace and the users and groups that are associated with the namespace.
-
deleteRefreshSchedule(params = {}, callback) ⇒ AWS.Request
Deletes a refresh schedule from a dataset.
.
-
deleteRoleCustomPermission(params = {}, callback) ⇒ AWS.Request
Removes custom permissions from the role.
.
-
deleteRoleMembership(params = {}, callback) ⇒ AWS.Request
Removes a group from a role.
.
-
deleteTemplate(params = {}, callback) ⇒ AWS.Request
Deletes a template.
.
-
deleteTemplateAlias(params = {}, callback) ⇒ AWS.Request
Deletes the item that the specified template alias points to.
-
deleteTheme(params = {}, callback) ⇒ AWS.Request
Deletes a theme.
.
-
deleteThemeAlias(params = {}, callback) ⇒ AWS.Request
Deletes the version of the theme that the specified theme alias points to.
-
deleteTopic(params = {}, callback) ⇒ AWS.Request
Deletes a topic.
.
-
deleteTopicRefreshSchedule(params = {}, callback) ⇒ AWS.Request
Deletes a topic refresh schedule.
.
-
deleteUser(params = {}, callback) ⇒ AWS.Request
Deletes the Amazon QuickSight user that is associated with the identity of the IAM user or role that's making the call.
-
deleteUserByPrincipalId(params = {}, callback) ⇒ AWS.Request
Deletes a user identified by its principal ID.
-
deleteVPCConnection(params = {}, callback) ⇒ AWS.Request
Deletes a VPC connection.
.
-
describeAccountCustomization(params = {}, callback) ⇒ AWS.Request
Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region.
-
describeAccountSettings(params = {}, callback) ⇒ AWS.Request
Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
.
-
describeAccountSubscription(params = {}, callback) ⇒ AWS.Request
Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription.
-
describeAnalysis(params = {}, callback) ⇒ AWS.Request
Provides a summary of the metadata for an analysis.
.
-
describeAnalysisDefinition(params = {}, callback) ⇒ AWS.Request
Provides a detailed description of the definition of an analysis.
Note: 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 theDescribeAnalysisinstead.- describeAnalysisPermissions(params = {}, callback) ⇒ AWS.Request
Provides the read and write permissions for an analysis.
.
- describeAssetBundleExportJob(params = {}, callback) ⇒ AWS.Request
Describes an existing export job.
Poll job descriptions after a job starts to know the status of the job.
- describeAssetBundleImportJob(params = {}, callback) ⇒ AWS.Request
Describes an existing import job.
Poll job descriptions after starting a job to know when it has succeeded or failed.
- describeDashboard(params = {}, callback) ⇒ AWS.Request
Provides a summary for a dashboard.
.
- describeDashboardDefinition(params = {}, callback) ⇒ AWS.Request
Provides a detailed description of the definition of a dashboard.
Note: 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 theDescribeDashboardinstead.- describeDashboardPermissions(params = {}, callback) ⇒ AWS.Request
Describes read and write permissions for a dashboard.
.
- describeDashboardSnapshotJob(params = {}, callback) ⇒ AWS.Request
Describes an existing snapshot job.
Poll job descriptions after a job starts to know the status of the job.
- describeDashboardSnapshotJobResult(params = {}, callback) ⇒ AWS.Request
Describes the result of an existing snapshot job that has finished running.
A finished snapshot job will return a
COMPLETEDorFAILEDstatus when you poll the job with aDescribeDashboardSnapshotJobAPI 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..- describeDataSet(params = {}, callback) ⇒ AWS.Request
Describes a dataset.
- describeDataSetPermissions(params = {}, callback) ⇒ AWS.Request
Describes the permissions on a dataset.
The permissions resource is
.arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.- describeDataSetRefreshProperties(params = {}, callback) ⇒ AWS.Request
Describes the refresh properties of a dataset.
.
- describeDataSource(params = {}, callback) ⇒ AWS.Request
Describes a data source.
.
- describeDataSourcePermissions(params = {}, callback) ⇒ AWS.Request
Describes the resource permissions for a data source.
.
- describeFolder(params = {}, callback) ⇒ AWS.Request
Describes a folder.
.
- describeFolderPermissions(params = {}, callback) ⇒ AWS.Request
Describes permissions for a folder.
.
- describeFolderResolvedPermissions(params = {}, callback) ⇒ AWS.Request
Describes the folder resolved permissions.
- describeGroup(params = {}, callback) ⇒ AWS.Request
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
- describeGroupMembership(params = {}, callback) ⇒ AWS.Request
Use the
DescribeGroupMembershipoperation to determine if a user is a member of the specified group.- describeIAMPolicyAssignment(params = {}, callback) ⇒ AWS.Request
Describes an existing IAM policy assignment, as specified by the assignment name.
.
- describeIngestion(params = {}, callback) ⇒ AWS.Request
Describes a SPICE ingestion.
.
- describeIpRestriction(params = {}, callback) ⇒ AWS.Request
Provides a summary and status of IP rules.
.
- describeKeyRegistration(params = {}, callback) ⇒ AWS.Request
Describes all customer managed key registrations in a Amazon QuickSight account.
.
- describeNamespace(params = {}, callback) ⇒ AWS.Request
Describes the current namespace.
.
- describeRefreshSchedule(params = {}, callback) ⇒ AWS.Request
Provides a summary of a refresh schedule.
.
- describeRoleCustomPermission(params = {}, callback) ⇒ AWS.Request
Describes all custom permissions that are mapped to a role.
.
- describeTemplate(params = {}, callback) ⇒ AWS.Request
Describes a template's metadata.
.
- describeTemplateAlias(params = {}, callback) ⇒ AWS.Request
Describes the template alias for a template.
.
- describeTemplateDefinition(params = {}, callback) ⇒ AWS.Request
Provides a detailed description of the definition of a template.
Note: 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 theDescribeTemplateinstead.- describeTemplatePermissions(params = {}, callback) ⇒ AWS.Request
Describes read and write permissions on a template.
.
- describeTheme(params = {}, callback) ⇒ AWS.Request
Describes a theme.
.
- describeThemeAlias(params = {}, callback) ⇒ AWS.Request
Describes the alias for a theme.
.
- describeThemePermissions(params = {}, callback) ⇒ AWS.Request
Describes the read and write permissions for a theme.
.
- describeTopic(params = {}, callback) ⇒ AWS.Request
Describes a topic.
.
- describeTopicPermissions(params = {}, callback) ⇒ AWS.Request
Describes the permissions of a topic.
.
- describeTopicRefresh(params = {}, callback) ⇒ AWS.Request
Describes the status of a topic refresh.
.
- describeTopicRefreshSchedule(params = {}, callback) ⇒ AWS.Request
Deletes a topic refresh schedule.
.
- describeUser(params = {}, callback) ⇒ AWS.Request
Returns information about a user, given the user name.
- describeVPCConnection(params = {}, callback) ⇒ AWS.Request
Describes a VPC connection.
.
- generateEmbedUrlForAnonymousUser(params = {}, callback) ⇒ AWS.Request
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.
- generateEmbedUrlForRegisteredUser(params = {}, callback) ⇒ AWS.Request
Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website.
- getDashboardEmbedUrl(params = {}, callback) ⇒ AWS.Request
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.
- getSessionEmbedUrl(params = {}, callback) ⇒ AWS.Request
Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in your web server code.
- listAnalyses(params = {}, callback) ⇒ AWS.Request
Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
.
- listAssetBundleExportJobs(params = {}, callback) ⇒ AWS.Request
Lists all asset bundle export jobs that have been taken place in the last 14 days.
- listAssetBundleImportJobs(params = {}, callback) ⇒ AWS.Request
Lists all asset bundle import jobs that have taken place in the last 14 days.
- listDashboards(params = {}, callback) ⇒ AWS.Request
Lists dashboards in an Amazon Web Services account.
.
- listDashboardVersions(params = {}, callback) ⇒ AWS.Request
Lists all the versions of the dashboards in the Amazon QuickSight subscription.
.
- listDataSets(params = {}, callback) ⇒ AWS.Request
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
The permissions resource is
.arn:aws:quicksight:region:aws-account-id:dataset/*.- listDataSources(params = {}, callback) ⇒ AWS.Request
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
.
- listFolderMembers(params = {}, callback) ⇒ AWS.Request
List all assets (
DASHBOARD,ANALYSIS, andDATASET) in a folder.- listFolders(params = {}, callback) ⇒ AWS.Request
Lists all folders in an account.
.
- listGroupMemberships(params = {}, callback) ⇒ AWS.Request
Lists member users in a group.
.
- listGroups(params = {}, callback) ⇒ AWS.Request
Lists all user groups in Amazon QuickSight.
- listIAMPolicyAssignments(params = {}, callback) ⇒ AWS.Request
Lists the IAM policy assignments in the current Amazon QuickSight account.
.
- listIAMPolicyAssignmentsForUser(params = {}, callback) ⇒ AWS.Request
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.
.
- listIdentityPropagationConfigs(params = {}, callback) ⇒ AWS.Request
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.
.- listIngestions(params = {}, callback) ⇒ AWS.Request
Lists the history of SPICE ingestions for a dataset.
.
- listNamespaces(params = {}, callback) ⇒ AWS.Request
Lists the namespaces for the specified Amazon Web Services account.
- listRefreshSchedules(params = {}, callback) ⇒ AWS.Request
Lists the refresh schedules of a dataset.
- listRoleMemberships(params = {}, callback) ⇒ AWS.Request
Lists all groups that are associated with a role.
.
- listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists the tags assigned to a resource.
.
- describeAnalysisPermissions(params = {}, callback) ⇒ AWS.Request