Skip to content

Commit 81b1f8c

Browse files
author
awstools
committed
feat(client-quicksight): This release adds APIs for Custom Permissions management in QuickSight, and APIs to support QuickSight Branding.
1 parent 1e42456 commit 81b1f8c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+14235
-6290
lines changed

clients/client-quicksight/README.md

Lines changed: 143 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,16 @@ using your favorite package manager:
2828

2929
The AWS SDK is modulized by clients and commands.
3030
To send a request, you only need to import the `QuickSightClient` and
31-
the commands you need, for example `ListFoldersCommand`:
31+
the commands you need, for example `ListBrandsCommand`:
3232

3333
```js
3434
// ES5 example
35-
const { QuickSightClient, ListFoldersCommand } = require("@aws-sdk/client-quicksight");
35+
const { QuickSightClient, ListBrandsCommand } = require("@aws-sdk/client-quicksight");
3636
```
3737

3838
```ts
3939
// ES6+ example
40-
import { QuickSightClient, ListFoldersCommand } from "@aws-sdk/client-quicksight";
40+
import { QuickSightClient, ListBrandsCommand } from "@aws-sdk/client-quicksight";
4141
```
4242

4343
### Usage
@@ -56,7 +56,7 @@ const client = new QuickSightClient({ region: "REGION" });
5656
const params = {
5757
/** input parameters */
5858
};
59-
const command = new ListFoldersCommand(params);
59+
const command = new ListBrandsCommand(params);
6060
```
6161

6262
#### Async/await
@@ -135,15 +135,15 @@ const client = new AWS.QuickSight({ region: "REGION" });
135135

136136
// async/await.
137137
try {
138-
const data = await client.listFolders(params);
138+
const data = await client.listBrands(params);
139139
// process data.
140140
} catch (error) {
141141
// error handling.
142142
}
143143

144144
// Promises.
145145
client
146-
.listFolders(params)
146+
.listBrands(params)
147147
.then((data) => {
148148
// process data.
149149
})
@@ -152,7 +152,7 @@ client
152152
});
153153

154154
// callbacks.
155-
client.listFolders(params, (err, data) => {
155+
client.listBrands(params, (err, data) => {
156156
// process err and data.
157157
});
158158
```
@@ -255,6 +255,22 @@ CreateAnalysis
255255

256256
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/CreateAnalysisCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/CreateAnalysisCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/CreateAnalysisCommandOutput/)
257257

258+
</details>
259+
<details>
260+
<summary>
261+
CreateBrand
262+
</summary>
263+
264+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/CreateBrandCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/CreateBrandCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/CreateBrandCommandOutput/)
265+
266+
</details>
267+
<details>
268+
<summary>
269+
CreateCustomPermissions
270+
</summary>
271+
272+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/CreateCustomPermissionsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/CreateCustomPermissionsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/CreateCustomPermissionsCommandOutput/)
273+
258274
</details>
259275
<details>
260276
<summary>
@@ -431,6 +447,30 @@ DeleteAnalysis
431447

432448
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DeleteAnalysisCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DeleteAnalysisCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DeleteAnalysisCommandOutput/)
433449

450+
</details>
451+
<details>
452+
<summary>
453+
DeleteBrand
454+
</summary>
455+
456+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DeleteBrandCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DeleteBrandCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DeleteBrandCommandOutput/)
457+
458+
</details>
459+
<details>
460+
<summary>
461+
DeleteBrandAssignment
462+
</summary>
463+
464+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DeleteBrandAssignmentCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DeleteBrandAssignmentCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DeleteBrandAssignmentCommandOutput/)
465+
466+
</details>
467+
<details>
468+
<summary>
469+
DeleteCustomPermissions
470+
</summary>
471+
472+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DeleteCustomPermissionsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DeleteCustomPermissionsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DeleteCustomPermissionsCommandOutput/)
473+
434474
</details>
435475
<details>
436476
<summary>
@@ -607,6 +647,14 @@ DeleteUserByPrincipalId
607647

608648
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DeleteUserByPrincipalIdCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DeleteUserByPrincipalIdCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DeleteUserByPrincipalIdCommandOutput/)
609649

650+
</details>
651+
<details>
652+
<summary>
653+
DeleteUserCustomPermission
654+
</summary>
655+
656+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DeleteUserCustomPermissionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DeleteUserCustomPermissionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DeleteUserCustomPermissionCommandOutput/)
657+
610658
</details>
611659
<details>
612660
<summary>
@@ -679,6 +727,38 @@ DescribeAssetBundleImportJob
679727

680728
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DescribeAssetBundleImportJobCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeAssetBundleImportJobCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeAssetBundleImportJobCommandOutput/)
681729

730+
</details>
731+
<details>
732+
<summary>
733+
DescribeBrand
734+
</summary>
735+
736+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DescribeBrandCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeBrandCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeBrandCommandOutput/)
737+
738+
</details>
739+
<details>
740+
<summary>
741+
DescribeBrandAssignment
742+
</summary>
743+
744+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DescribeBrandAssignmentCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeBrandAssignmentCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeBrandAssignmentCommandOutput/)
745+
746+
</details>
747+
<details>
748+
<summary>
749+
DescribeBrandPublishedVersion
750+
</summary>
751+
752+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DescribeBrandPublishedVersionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeBrandPublishedVersionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeBrandPublishedVersionCommandOutput/)
753+
754+
</details>
755+
<details>
756+
<summary>
757+
DescribeCustomPermissions
758+
</summary>
759+
760+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/DescribeCustomPermissionsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeCustomPermissionsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/DescribeCustomPermissionsCommandOutput/)
761+
682762
</details>
683763
<details>
684764
<summary>
@@ -1023,6 +1103,22 @@ ListAssetBundleImportJobs
10231103

10241104
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/ListAssetBundleImportJobsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/ListAssetBundleImportJobsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/ListAssetBundleImportJobsCommandOutput/)
10251105

1106+
</details>
1107+
<details>
1108+
<summary>
1109+
ListBrands
1110+
</summary>
1111+
1112+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/ListBrandsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/ListBrandsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/ListBrandsCommandOutput/)
1113+
1114+
</details>
1115+
<details>
1116+
<summary>
1117+
ListCustomPermissions
1118+
</summary>
1119+
1120+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/ListCustomPermissionsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/ListCustomPermissionsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/ListCustomPermissionsCommandOutput/)
1121+
10261122
</details>
10271123
<details>
10281124
<summary>
@@ -1407,6 +1503,38 @@ UpdateAnalysisPermissions
14071503

14081504
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/UpdateAnalysisPermissionsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateAnalysisPermissionsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateAnalysisPermissionsCommandOutput/)
14091505

1506+
</details>
1507+
<details>
1508+
<summary>
1509+
UpdateBrand
1510+
</summary>
1511+
1512+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/UpdateBrandCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateBrandCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateBrandCommandOutput/)
1513+
1514+
</details>
1515+
<details>
1516+
<summary>
1517+
UpdateBrandAssignment
1518+
</summary>
1519+
1520+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/UpdateBrandAssignmentCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateBrandAssignmentCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateBrandAssignmentCommandOutput/)
1521+
1522+
</details>
1523+
<details>
1524+
<summary>
1525+
UpdateBrandPublishedVersion
1526+
</summary>
1527+
1528+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/UpdateBrandPublishedVersionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateBrandPublishedVersionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateBrandPublishedVersionCommandOutput/)
1529+
1530+
</details>
1531+
<details>
1532+
<summary>
1533+
UpdateCustomPermissions
1534+
</summary>
1535+
1536+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/UpdateCustomPermissionsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateCustomPermissionsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateCustomPermissionsCommandOutput/)
1537+
14101538
</details>
14111539
<details>
14121540
<summary>
@@ -1647,6 +1775,14 @@ UpdateUser
16471775

16481776
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/UpdateUserCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateUserCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateUserCommandOutput/)
16491777

1778+
</details>
1779+
<details>
1780+
<summary>
1781+
UpdateUserCustomPermission
1782+
</summary>
1783+
1784+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/UpdateUserCustomPermissionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateUserCustomPermissionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateUserCustomPermissionCommandOutput/)
1785+
16501786
</details>
16511787
<details>
16521788
<summary>

0 commit comments

Comments
 (0)