@aws-sdk/client-quicksight 3.418.0 → 3.421.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -7
- package/dist-cjs/models/models_2.js +1 -0
- package/dist-cjs/protocols/Aws_restJson1.js +1 -0
- package/dist-es/models/models_2.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +1 -0
- package/dist-types/commands/CreateFolderMembershipCommand.d.ts +2 -2
- package/dist-types/commands/DeleteFolderMembershipCommand.d.ts +1 -1
- package/dist-types/commands/RegisterUserCommand.d.ts +6 -0
- package/dist-types/commands/TagResourceCommand.d.ts +2 -5
- package/dist-types/models/models_2.d.ts +1 -0
- package/dist-types/models/models_3.d.ts +5 -0
- package/dist-types/ts3.4/models/models_2.d.ts +1 -0
- package/dist-types/ts3.4/models/models_3.d.ts +1 -0
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -28,16 +28,16 @@ using your favorite package manager:
|
|
|
28
28
|
|
|
29
29
|
The AWS SDK is modulized by clients and commands.
|
|
30
30
|
To send a request, you only need to import the `QuickSightClient` and
|
|
31
|
-
the commands you need, for example `
|
|
31
|
+
the commands you need, for example `ListFoldersCommand`:
|
|
32
32
|
|
|
33
33
|
```js
|
|
34
34
|
// ES5 example
|
|
35
|
-
const { QuickSightClient,
|
|
35
|
+
const { QuickSightClient, ListFoldersCommand } = require("@aws-sdk/client-quicksight");
|
|
36
36
|
```
|
|
37
37
|
|
|
38
38
|
```ts
|
|
39
39
|
// ES6+ example
|
|
40
|
-
import { QuickSightClient,
|
|
40
|
+
import { QuickSightClient, ListFoldersCommand } from "@aws-sdk/client-quicksight";
|
|
41
41
|
```
|
|
42
42
|
|
|
43
43
|
### Usage
|
|
@@ -56,7 +56,7 @@ const client = new QuickSightClient({ region: "REGION" });
|
|
|
56
56
|
const params = {
|
|
57
57
|
/** input parameters */
|
|
58
58
|
};
|
|
59
|
-
const command = new
|
|
59
|
+
const command = new ListFoldersCommand(params);
|
|
60
60
|
```
|
|
61
61
|
|
|
62
62
|
#### Async/await
|
|
@@ -135,7 +135,7 @@ const client = new AWS.QuickSight({ region: "REGION" });
|
|
|
135
135
|
|
|
136
136
|
// async/await.
|
|
137
137
|
try {
|
|
138
|
-
const data = await client.
|
|
138
|
+
const data = await client.listFolders(params);
|
|
139
139
|
// process data.
|
|
140
140
|
} catch (error) {
|
|
141
141
|
// error handling.
|
|
@@ -143,7 +143,7 @@ try {
|
|
|
143
143
|
|
|
144
144
|
// Promises.
|
|
145
145
|
client
|
|
146
|
-
.
|
|
146
|
+
.listFolders(params)
|
|
147
147
|
.then((data) => {
|
|
148
148
|
// process data.
|
|
149
149
|
})
|
|
@@ -152,7 +152,7 @@ client
|
|
|
152
152
|
});
|
|
153
153
|
|
|
154
154
|
// callbacks.
|
|
155
|
-
client.
|
|
155
|
+
client.listFolders(params, (err, data) => {
|
|
156
156
|
// process err and data.
|
|
157
157
|
});
|
|
158
158
|
```
|
|
@@ -34,7 +34,7 @@ export interface CreateFolderMembershipCommandOutput extends CreateFolderMembers
|
|
|
34
34
|
* AwsAccountId: "STRING_VALUE", // required
|
|
35
35
|
* FolderId: "STRING_VALUE", // required
|
|
36
36
|
* MemberId: "STRING_VALUE", // required
|
|
37
|
-
* MemberType: "DASHBOARD" || "ANALYSIS" || "DATASET", // required
|
|
37
|
+
* MemberType: "DASHBOARD" || "ANALYSIS" || "DATASET" || "TOPIC", // required
|
|
38
38
|
* };
|
|
39
39
|
* const command = new CreateFolderMembershipCommand(input);
|
|
40
40
|
* const response = await client.send(command);
|
|
@@ -42,7 +42,7 @@ export interface CreateFolderMembershipCommandOutput extends CreateFolderMembers
|
|
|
42
42
|
* // Status: Number("int"),
|
|
43
43
|
* // FolderMember: { // FolderMember
|
|
44
44
|
* // MemberId: "STRING_VALUE",
|
|
45
|
-
* // MemberType: "DASHBOARD" || "ANALYSIS" || "DATASET",
|
|
45
|
+
* // MemberType: "DASHBOARD" || "ANALYSIS" || "DATASET" || "TOPIC",
|
|
46
46
|
* // },
|
|
47
47
|
* // RequestId: "STRING_VALUE",
|
|
48
48
|
* // };
|
|
@@ -34,7 +34,7 @@ export interface DeleteFolderMembershipCommandOutput extends DeleteFolderMembers
|
|
|
34
34
|
* AwsAccountId: "STRING_VALUE", // required
|
|
35
35
|
* FolderId: "STRING_VALUE", // required
|
|
36
36
|
* MemberId: "STRING_VALUE", // required
|
|
37
|
-
* MemberType: "DASHBOARD" || "ANALYSIS" || "DATASET", // required
|
|
37
|
+
* MemberType: "DASHBOARD" || "ANALYSIS" || "DATASET" || "TOPIC", // required
|
|
38
38
|
* };
|
|
39
39
|
* const command = new DeleteFolderMembershipCommand(input);
|
|
40
40
|
* const response = await client.send(command);
|
|
@@ -43,6 +43,12 @@ export interface RegisterUserCommandOutput extends RegisterUserResponse, __Metad
|
|
|
43
43
|
* ExternalLoginFederationProviderType: "STRING_VALUE",
|
|
44
44
|
* CustomFederationProviderUrl: "STRING_VALUE",
|
|
45
45
|
* ExternalLoginId: "STRING_VALUE",
|
|
46
|
+
* Tags: [ // TagList
|
|
47
|
+
* { // Tag
|
|
48
|
+
* Key: "STRING_VALUE", // required
|
|
49
|
+
* Value: "STRING_VALUE", // required
|
|
50
|
+
* },
|
|
51
|
+
* ],
|
|
46
52
|
* };
|
|
47
53
|
* const command = new RegisterUserCommand(input);
|
|
48
54
|
* const response = await client.send(command);
|
|
@@ -32,15 +32,12 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
|
|
|
32
32
|
* that is already associated with the resource, the new tag value that you specify
|
|
33
33
|
* replaces the previous value for that tag.</p>
|
|
34
34
|
* <p>You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data
|
|
35
|
-
* set, data source, dashboard, template, and
|
|
35
|
+
* set, data source, dashboard, template, topic, and user. </p>
|
|
36
36
|
* <p>Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for
|
|
37
37
|
* the following:</p>
|
|
38
38
|
* <ul>
|
|
39
39
|
* <li>
|
|
40
|
-
* <p>
|
|
41
|
-
* possible because you can't tag the resources that Amazon QuickSight costs are based
|
|
42
|
-
* on, for example Amazon QuickSight storage capacity (SPICE), number of users, type
|
|
43
|
-
* of users, and usage metrics.</p>
|
|
40
|
+
* <p>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.</p>
|
|
44
41
|
* </li>
|
|
45
42
|
* <li>
|
|
46
43
|
* <p>Amazon QuickSight doesn't currently support the tag editor for Resource Groups.</p>
|
|
@@ -7308,6 +7308,11 @@ export interface RegisterUserRequest {
|
|
|
7308
7308
|
* <p>The identity ID for a user in the external login provider.</p>
|
|
7309
7309
|
*/
|
|
7310
7310
|
ExternalLoginId?: string;
|
|
7311
|
+
/**
|
|
7312
|
+
* @public
|
|
7313
|
+
* <p>The tags to associate with the user.</p>
|
|
7314
|
+
*/
|
|
7315
|
+
Tags?: Tag[];
|
|
7311
7316
|
}
|
|
7312
7317
|
/**
|
|
7313
7318
|
* @public
|
|
@@ -1999,6 +1999,7 @@ export declare const MemberType: {
|
|
|
1999
1999
|
readonly ANALYSIS: "ANALYSIS";
|
|
2000
2000
|
readonly DASHBOARD: "DASHBOARD";
|
|
2001
2001
|
readonly DATASET: "DATASET";
|
|
2002
|
+
readonly TOPIC: "TOPIC";
|
|
2002
2003
|
};
|
|
2003
2004
|
export type MemberType = (typeof MemberType)[keyof typeof MemberType];
|
|
2004
2005
|
export interface CreateFolderMembershipRequest {
|
|
@@ -1789,6 +1789,7 @@ export interface RegisterUserRequest {
|
|
|
1789
1789
|
ExternalLoginFederationProviderType?: string;
|
|
1790
1790
|
CustomFederationProviderUrl?: string;
|
|
1791
1791
|
ExternalLoginId?: string;
|
|
1792
|
+
Tags?: Tag[];
|
|
1792
1793
|
}
|
|
1793
1794
|
export interface RegisterUserResponse {
|
|
1794
1795
|
User?: User;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-quicksight",
|
|
3
3
|
"description": "AWS SDK for JavaScript Quicksight Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.421.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,8 +21,8 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.421.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.421.0",
|
|
26
26
|
"@aws-sdk/middleware-host-header": "3.418.0",
|
|
27
27
|
"@aws-sdk/middleware-logger": "3.418.0",
|
|
28
28
|
"@aws-sdk/middleware-recursion-detection": "3.418.0",
|