@aws-sdk/client-quicksight 3.142.0 → 3.154.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/CHANGELOG.md +24 -0
- package/dist-types/QuickSight.d.ts +7 -4
- package/dist-types/commands/CreateGroupCommand.d.ts +1 -1
- package/dist-types/commands/GetDashboardEmbedUrlCommand.d.ts +5 -2
- package/dist-types/commands/ListNamespacesCommand.d.ts +1 -1
- package/dist-types/models/models_1.d.ts +23 -7
- package/package.json +9 -4
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,30 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
# [3.154.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.153.0...v3.154.0) (2022-08-19)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @aws-sdk/client-quicksight
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
# [3.150.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.149.0...v3.150.0) (2022-08-15)
|
|
15
|
+
|
|
16
|
+
**Note:** Version bump only for package @aws-sdk/client-quicksight
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
# [3.145.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.144.0...v3.145.0) (2022-08-08)
|
|
23
|
+
|
|
24
|
+
**Note:** Version bump only for package @aws-sdk/client-quicksight
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
6
30
|
# [3.142.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.141.0...v3.142.0) (2022-08-02)
|
|
7
31
|
|
|
8
32
|
|
|
@@ -240,7 +240,7 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
240
240
|
createFolderMembership(args: CreateFolderMembershipCommandInput, cb: (err: any, data?: CreateFolderMembershipCommandOutput) => void): void;
|
|
241
241
|
createFolderMembership(args: CreateFolderMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFolderMembershipCommandOutput) => void): void;
|
|
242
242
|
/**
|
|
243
|
-
* <p>
|
|
243
|
+
* <p>Use the <code>CreateGroup</code> 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 AWS Support.</p>
|
|
244
244
|
* <p>The permissions resource is
|
|
245
245
|
* <code>arn:aws:quicksight:<your-region>:<i><relevant-aws-account-id></i>:group/default/<i><group-name></i>
|
|
246
246
|
* </code>.</p>
|
|
@@ -718,7 +718,7 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
718
718
|
generateEmbedUrlForRegisteredUser(args: GenerateEmbedUrlForRegisteredUserCommandInput, cb: (err: any, data?: GenerateEmbedUrlForRegisteredUserCommandOutput) => void): void;
|
|
719
719
|
generateEmbedUrlForRegisteredUser(args: GenerateEmbedUrlForRegisteredUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateEmbedUrlForRegisteredUserCommandOutput) => void): void;
|
|
720
720
|
/**
|
|
721
|
-
* <p>Generates a temporary session URL and authorization code 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. </p>
|
|
721
|
+
* <p>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. </p>
|
|
722
722
|
* <p>Currently, you can use <code>GetDashboardEmbedURL</code> only from the server, not from the user's browser. The following rules apply to the generated URL:</p>
|
|
723
723
|
* <ul>
|
|
724
724
|
* <li>
|
|
@@ -731,7 +731,10 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
731
731
|
* <p>They are valid for 5 minutes after you run this command.</p>
|
|
732
732
|
* </li>
|
|
733
733
|
* <li>
|
|
734
|
-
* <p>
|
|
734
|
+
* <p>You are charged only when the URL is used or there is interaction with Amazon QuickSight.</p>
|
|
735
|
+
* </li>
|
|
736
|
+
* <li>
|
|
737
|
+
* <p>The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional <code>SessionLifetimeInMinutes</code> parameter to customize session duration.</p>
|
|
735
738
|
* </li>
|
|
736
739
|
* </ul>
|
|
737
740
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-deprecated.html">Embedding Analytics Using GetDashboardEmbedUrl</a> in the <i>Amazon QuickSight User
|
|
@@ -848,7 +851,7 @@ export declare class QuickSight extends QuickSightClient {
|
|
|
848
851
|
listIngestions(args: ListIngestionsCommandInput, cb: (err: any, data?: ListIngestionsCommandOutput) => void): void;
|
|
849
852
|
listIngestions(args: ListIngestionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIngestionsCommandOutput) => void): void;
|
|
850
853
|
/**
|
|
851
|
-
* <p>Lists the namespaces for the specified Amazon Web Services account.</p>
|
|
854
|
+
* <p>Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.</p>
|
|
852
855
|
*/
|
|
853
856
|
listNamespaces(args: ListNamespacesCommandInput, options?: __HttpHandlerOptions): Promise<ListNamespacesCommandOutput>;
|
|
854
857
|
listNamespaces(args: ListNamespacesCommandInput, cb: (err: any, data?: ListNamespacesCommandOutput) => void): void;
|
|
@@ -7,7 +7,7 @@ export interface CreateGroupCommandInput extends CreateGroupRequest {
|
|
|
7
7
|
export interface CreateGroupCommandOutput extends CreateGroupResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Use the <code>CreateGroup</code> 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 AWS Support.</p>
|
|
11
11
|
* <p>The permissions resource is
|
|
12
12
|
* <code>arn:aws:quicksight:<your-region>:<i><relevant-aws-account-id></i>:group/default/<i><group-name></i>
|
|
13
13
|
* </code>.</p>
|
|
@@ -7,7 +7,7 @@ export interface GetDashboardEmbedUrlCommandInput extends GetDashboardEmbedUrlRe
|
|
|
7
7
|
export interface GetDashboardEmbedUrlCommandOutput extends GetDashboardEmbedUrlResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Generates a temporary session URL and authorization code 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. </p>
|
|
10
|
+
* <p>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. </p>
|
|
11
11
|
* <p>Currently, you can use <code>GetDashboardEmbedURL</code> only from the server, not from the user's browser. The following rules apply to the generated URL:</p>
|
|
12
12
|
* <ul>
|
|
13
13
|
* <li>
|
|
@@ -20,7 +20,10 @@ export interface GetDashboardEmbedUrlCommandOutput extends GetDashboardEmbedUrlR
|
|
|
20
20
|
* <p>They are valid for 5 minutes after you run this command.</p>
|
|
21
21
|
* </li>
|
|
22
22
|
* <li>
|
|
23
|
-
* <p>
|
|
23
|
+
* <p>You are charged only when the URL is used or there is interaction with Amazon QuickSight.</p>
|
|
24
|
+
* </li>
|
|
25
|
+
* <li>
|
|
26
|
+
* <p>The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional <code>SessionLifetimeInMinutes</code> parameter to customize session duration.</p>
|
|
24
27
|
* </li>
|
|
25
28
|
* </ul>
|
|
26
29
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-deprecated.html">Embedding Analytics Using GetDashboardEmbedUrl</a> in the <i>Amazon QuickSight User
|
|
@@ -7,7 +7,7 @@ export interface ListNamespacesCommandInput extends ListNamespacesRequest {
|
|
|
7
7
|
export interface ListNamespacesCommandOutput extends ListNamespacesResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Lists the namespaces for the specified Amazon Web Services account.</p>
|
|
10
|
+
* <p>Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -395,7 +395,11 @@ export interface GenerateEmbedUrlForAnonymousUserRequest {
|
|
|
395
395
|
*/
|
|
396
396
|
SessionTags?: SessionTag[];
|
|
397
397
|
/**
|
|
398
|
-
* <p>The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user
|
|
398
|
+
* <p>The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user
|
|
399
|
+
* is authorized to access during the lifetime of the session. If you choose
|
|
400
|
+
* <code>Dashboard</code> embedding experience, pass the list of dashboard ARNs in the
|
|
401
|
+
* account that you want the user to be able to view. Currently, you can pass up to 25
|
|
402
|
+
* dashboard ARNs in each API call.</p>
|
|
399
403
|
*/
|
|
400
404
|
AuthorizedResourceArns: string[] | undefined;
|
|
401
405
|
/**
|
|
@@ -403,8 +407,14 @@ export interface GenerateEmbedUrlForAnonymousUserRequest {
|
|
|
403
407
|
*/
|
|
404
408
|
ExperienceConfiguration: AnonymousUserEmbeddingExperienceConfiguration | undefined;
|
|
405
409
|
/**
|
|
406
|
-
* <p>The domains that you want to add to the allow list for access to the generated URL that
|
|
407
|
-
*
|
|
410
|
+
* <p>The domains that you want to add to the allow list for access to the generated URL that
|
|
411
|
+
* is then embedded. This optional parameter overrides the static domains that are
|
|
412
|
+
* configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it
|
|
413
|
+
* allows only the domains that you include in this parameter. You can list up to three
|
|
414
|
+
* domains or subdomains in each API call.</p>
|
|
415
|
+
* <p>To include all subdomains under a specific domain to the allow list, use <code>*</code>.
|
|
416
|
+
* For example, <code>https://*.sapp.amazon.com</code> includes all subdomains under
|
|
417
|
+
* <code>https://sapp.amazon.com</code>.</p>
|
|
408
418
|
*/
|
|
409
419
|
AllowedDomains?: string[];
|
|
410
420
|
}
|
|
@@ -598,8 +608,14 @@ export interface GenerateEmbedUrlForRegisteredUserRequest {
|
|
|
598
608
|
*/
|
|
599
609
|
ExperienceConfiguration: RegisteredUserEmbeddingExperienceConfiguration | undefined;
|
|
600
610
|
/**
|
|
601
|
-
* <p>The domains that you want to add to the allow list for access to the generated URL that
|
|
602
|
-
*
|
|
611
|
+
* <p>The domains that you want to add to the allow list for access to the generated URL that
|
|
612
|
+
* is then embedded. This optional parameter overrides the static domains that are
|
|
613
|
+
* configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it
|
|
614
|
+
* allows only the domains that you include in this parameter. You can list up to three
|
|
615
|
+
* domains or subdomains in each API call.</p>
|
|
616
|
+
* <p>To include all subdomains under a specific domain to the allow list, use <code>*</code>.
|
|
617
|
+
* For example, <code>https://*.sapp.amazon.com</code> includes all subdomains under
|
|
618
|
+
* <code>https://sapp.amazon.com</code>.</p>
|
|
603
619
|
*/
|
|
604
620
|
AllowedDomains?: string[];
|
|
605
621
|
}
|
|
@@ -1300,7 +1316,7 @@ export interface ListNamespacesRequest {
|
|
|
1300
1316
|
*/
|
|
1301
1317
|
AwsAccountId: string | undefined;
|
|
1302
1318
|
/**
|
|
1303
|
-
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
1319
|
+
* <p>A unique pagination token that can be used in a subsequent request. You will receive a pagination token in the response body of a previous <code>ListNameSpaces</code> API call if there is more data that can be returned. To receive the data, make another <code>ListNamespaces</code> API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a <code>ListNamespaces</code> API call with an expired token, you will receive a <code>HTTP 400 InvalidNextTokenException</code> error.</p>
|
|
1304
1320
|
*/
|
|
1305
1321
|
NextToken?: string;
|
|
1306
1322
|
/**
|
|
@@ -1316,7 +1332,7 @@ export interface ListNamespacesResponse {
|
|
|
1316
1332
|
*/
|
|
1317
1333
|
Namespaces?: NamespaceInfoV2[];
|
|
1318
1334
|
/**
|
|
1319
|
-
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
1335
|
+
* <p>A unique pagination token that can be used in a subsequent request. Receiving <code>NextToken</code> in your response inticates that there is more data that can be returned. To receive the data, make another <code>ListNamespaces</code> API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a <code>ListNamespaces</code> API call with an expired token, you will receive a <code>HTTP 400 InvalidNextTokenException</code> error.</p>
|
|
1320
1336
|
*/
|
|
1321
1337
|
NextToken?: string;
|
|
1322
1338
|
/**
|
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.154.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",
|
|
@@ -18,9 +18,9 @@
|
|
|
18
18
|
"dependencies": {
|
|
19
19
|
"@aws-crypto/sha256-browser": "2.0.0",
|
|
20
20
|
"@aws-crypto/sha256-js": "2.0.0",
|
|
21
|
-
"@aws-sdk/client-sts": "3.
|
|
21
|
+
"@aws-sdk/client-sts": "3.154.0",
|
|
22
22
|
"@aws-sdk/config-resolver": "3.130.0",
|
|
23
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
23
|
+
"@aws-sdk/credential-provider-node": "3.154.0",
|
|
24
24
|
"@aws-sdk/fetch-http-handler": "3.131.0",
|
|
25
25
|
"@aws-sdk/hash-node": "3.127.0",
|
|
26
26
|
"@aws-sdk/invalid-dependency": "3.127.0",
|
|
@@ -41,7 +41,7 @@
|
|
|
41
41
|
"@aws-sdk/url-parser": "3.127.0",
|
|
42
42
|
"@aws-sdk/util-base64-browser": "3.109.0",
|
|
43
43
|
"@aws-sdk/util-base64-node": "3.55.0",
|
|
44
|
-
"@aws-sdk/util-body-length-browser": "3.
|
|
44
|
+
"@aws-sdk/util-body-length-browser": "3.154.0",
|
|
45
45
|
"@aws-sdk/util-body-length-node": "3.55.0",
|
|
46
46
|
"@aws-sdk/util-defaults-mode-browser": "3.142.0",
|
|
47
47
|
"@aws-sdk/util-defaults-mode-node": "3.142.0",
|
|
@@ -61,6 +61,11 @@
|
|
|
61
61
|
"typedoc": "0.19.2",
|
|
62
62
|
"typescript": "~4.6.2"
|
|
63
63
|
},
|
|
64
|
+
"overrides": {
|
|
65
|
+
"typedoc": {
|
|
66
|
+
"typescript": "~4.6.2"
|
|
67
|
+
}
|
|
68
|
+
},
|
|
64
69
|
"engines": {
|
|
65
70
|
"node": ">=12.0.0"
|
|
66
71
|
},
|