@aws-sdk/client-quicksight

Description

AWS SDK for JavaScript QuickSight Client for Node.js, Browser and React Native.

Amazon Quick Suite API Reference

Amazon Quick Sight 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 Quick Sight.

Installing

To install this package, simply type add or install @aws-sdk/client-quicksight
using your favorite package manager:
- npm install @aws-sdk/client-quicksight
- yarn add @aws-sdk/client-quicksight
- pnpm add @aws-sdk/client-quicksight

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the QuickSightClient and
the commands you need, for example ListBrandsCommand:

``js
// ES5 example
const { QuickSightClient, ListBrandsCommand } = require("@aws-sdk/client-quicksight");
`

`ts
// ES6+ example
import { QuickSightClient, ListBrandsCommand } from "@aws-sdk/client-quicksight";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new QuickSightClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListBrandsCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-quicksight";
const client = new AWS.QuickSight({ region: "REGION" });

// async/await.
try {
const data = await client.listBrands(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listBrands(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listBrands(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

Getting Help

Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-quicksight` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

BatchCreateTopicReviewedAnswer

Command API Reference / Input / Output

BatchDeleteTopicReviewedAnswer

Command API Reference / Input / Output

CancelIngestion

Command API Reference / Input / Output

CreateAccountCustomization

Command API Reference / Input / Output

CreateAccountSubscription

Command API Reference / Input / Output

CreateActionConnector

Command API Reference / Input / Output

CreateAnalysis

Command API Reference / Input / Output

CreateBrand

Command API Reference / Input / Output

CreateCustomPermissions

Command API Reference / Input / Output

CreateDashboard

Command API Reference / Input / Output

CreateDataSet

Command API Reference / Input / Output

CreateDataSource

Command API Reference / Input / Output

CreateFolder

Command API Reference / Input / Output

CreateFolderMembership

Command API Reference / Input / Output

CreateGroup

Command API Reference / Input / Output

CreateGroupMembership

Command API Reference / Input / Output

CreateIAMPolicyAssignment

Command API Reference / Input / Output

CreateIngestion

Command API Reference / Input / Output

CreateNamespace

Command API Reference / Input / Output

CreateRefreshSchedule

Command API Reference / Input / Output

CreateRoleMembership

Command API Reference / Input / Output

CreateTemplate

Command API Reference / Input / Output

CreateTemplateAlias

Command API Reference / Input / Output

CreateTheme

Command API Reference / Input / Output

CreateThemeAlias

Command API Reference / Input / Output

CreateTopic

Command API Reference / Input / Output

CreateTopicRefreshSchedule

Command API Reference / Input / Output

CreateVPCConnection

Command API Reference / Input / Output

DeleteAccountCustomization

Command API Reference / Input / Output

DeleteAccountCustomPermission

Command API Reference / Input / Output

DeleteAccountSubscription

Command API Reference / Input / Output

DeleteActionConnector

Command API Reference / Input / Output

DeleteAnalysis

Command API Reference / Input / Output

DeleteBrand

Command API Reference / Input / Output

DeleteBrandAssignment

Command API Reference / Input / Output

DeleteCustomPermissions

Command API Reference / Input / Output

DeleteDashboard

Command API Reference / Input / Output

DeleteDataSet

Command API Reference / Input / Output

DeleteDataSetRefreshProperties

Command API Reference / Input / Output

DeleteDataSource

Command API Reference / Input / Output

DeleteDefaultQBusinessApplication

Command API Reference / Input / Output

DeleteFolder

Command API Reference / Input / Output

DeleteFolderMembership

Command API Reference / Input / Output

DeleteGroup

Command API Reference / Input / Output

DeleteGroupMembership

Command API Reference / Input / Output

DeleteIAMPolicyAssignment

Command API Reference / Input / Output

DeleteIdentityPropagationConfig

Command API Reference / Input / Output

DeleteNamespace

Command API Reference / Input / Output

DeleteRefreshSchedule

Command API Reference / Input / Output

DeleteRoleCustomPermission

Command API Reference / Input / Output

DeleteRoleMembership

Command API Reference / Input / Output

DeleteTemplate

Command API Reference / Input / Output

DeleteTemplateAlias

Command API Reference / Input / Output

DeleteTheme

Command API Reference / Input / Output

DeleteThemeAlias

Command API Reference / Input / Output

DeleteTopic

Command API Reference / Input / Output

DeleteTopicRefreshSchedule

Command API Reference / Input / Output

DeleteUser

Command API Reference / Input / Output

DeleteUserByPrincipalId

Command API Reference / Input / Output

DeleteUserCustomPermission

Command API Reference / Input / Output

DeleteVPCConnection

Command API Reference / Input / Output

DescribeAccountCustomization

Command API Reference / Input / Output

DescribeAccountCustomPermission

Command API Reference / Input / Output

DescribeAccountSettings

Command API Reference / Input / Output

DescribeAccountSubscription

Command API Reference / Input / Output

DescribeActionConnector

Command API Reference / Input / Output

DescribeActionConnectorPermissions

Command API Reference / Input / Output

DescribeAnalysis

Command API Reference / Input / Output

DescribeAnalysisDefinition

Command API Reference / Input / Output

DescribeAnalysisPermissions

Command API Reference / Input / Output

DescribeAssetBundleExportJob

Command API Reference / Input / Output

DescribeAssetBundleImportJob

Command API Reference / Input / Output

DescribeBrand

Command API Reference / Input / Output

DescribeBrandAssignment

Command API Reference / Input / Output

DescribeBrandPublishedVersion

Command API Reference / Input / Output

DescribeCustomPermissions

Command API Reference / Input / Output

DescribeDashboard

Command API Reference / Input / Output

DescribeDashboardDefinition

Command API Reference / Input / Output

DescribeDashboardPermissions

Command API Reference / Input / Output

DescribeDashboardSnapshotJob

Command API Reference / Input / Output

DescribeDashboardSnapshotJobResult

Command API Reference / Input / Output

DescribeDashboardsQAConfiguration

Command API Reference / Input / Output

DescribeDataSet

Command API Reference / Input / Output

DescribeDataSetPermissions

Command API Reference / Input / Output

DescribeDataSetRefreshProperties

Command API Reference / Input / Output

DescribeDataSource

Command API Reference / Input / Output

DescribeDataSourcePermissions

Command API Reference / Input / Output

DescribeDefaultQBusinessApplication

Command API Reference / Input / Output

DescribeFolder

Command API Reference / Input / Output

DescribeFolderPermissions

Command API Reference / Input / Output

DescribeFolderResolvedPermissions

Command API Reference / Input / Output

DescribeGroup

Command API Reference / Input / Output

DescribeGroupMembership

Command API Reference / Input / Output

DescribeIAMPolicyAssignment

Command API Reference / Input / Output

DescribeIngestion

Command API Reference / Input / Output

DescribeIpRestriction

Command API Reference / Input / Output

DescribeKeyRegistration

Command API Reference / Input / Output

DescribeNamespace

Command API Reference / Input / Output

DescribeQPersonalizationConfiguration

Command API Reference / Input / Output

DescribeQuickSightQSearchConfiguration

Command API Reference / Input / Output

DescribeRefreshSchedule

Command API Reference / Input / Output

DescribeRoleCustomPermission

Command API Reference / Input / Output

DescribeSelfUpgradeConfiguration

Command API Reference / Input / Output

DescribeTemplate

Command API Reference / Input / Output

DescribeTemplateAlias

Command API Reference / Input / Output

DescribeTemplateDefinition

Command API Reference / Input / Output

DescribeTemplatePermissions

Command API Reference / Input / Output

DescribeTheme

Command API Reference / Input / Output

DescribeThemeAlias

Command API Reference / Input / Output

DescribeThemePermissions

Command API Reference / Input / Output

DescribeTopic

Command API Reference / Input / Output

DescribeTopicPermissions

Command API Reference / Input / Output

DescribeTopicRefresh

Command API Reference / Input / Output

DescribeTopicRefreshSchedule

Command API Reference / Input / Output

DescribeUser

Command API Reference / Input / Output

DescribeVPCConnection

Command API Reference / Input / Output

GenerateEmbedUrlForAnonymousUser

Command API Reference / Input / Output

GenerateEmbedUrlForRegisteredUser

Command API Reference / Input / Output

GenerateEmbedUrlForRegisteredUserWithIdentity

Command API Reference / Input / Output

GetDashboardEmbedUrl

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/GetDashboard