@aws-sdk/client-quicksight 3.42.0 → 3.47.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 +51 -0
- package/dist-cjs/endpoints.js +1 -0
- package/dist-cjs/models/models_0.js +21 -96
- package/dist-cjs/models/models_1.js +17 -33
- package/dist-cjs/protocols/Aws_restJson1.js +80 -0
- package/dist-cjs/runtimeConfig.browser.js +7 -2
- package/dist-cjs/runtimeConfig.js +9 -3
- package/dist-es/endpoints.js +1 -0
- package/dist-es/models/models_0.js +13 -64
- package/dist-es/models/models_1.js +12 -20
- package/dist-es/protocols/Aws_restJson1.js +189 -115
- package/dist-es/runtimeConfig.browser.js +12 -3
- package/dist-es/runtimeConfig.js +13 -6
- package/dist-types/QuickSight.d.ts +47 -37
- package/dist-types/QuickSightClient.d.ts +5 -1
- package/dist-types/commands/CreateAccountCustomizationCommand.d.ts +7 -5
- package/dist-types/commands/CreateDashboardCommand.d.ts +5 -3
- package/dist-types/commands/CreateDataSetCommand.d.ts +1 -1
- package/dist-types/commands/CreateIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist-types/commands/CreateIngestionCommand.d.ts +4 -1
- package/dist-types/commands/DeleteIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAccountCustomizationCommand.d.ts +4 -4
- package/dist-types/commands/DescribeDataSetCommand.d.ts +1 -1
- package/dist-types/commands/DescribeIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist-types/commands/DescribeIpRestrictionCommand.d.ts +1 -1
- package/dist-types/commands/GetSessionEmbedUrlCommand.d.ts +4 -3
- package/dist-types/commands/ListIAMPolicyAssignmentsCommand.d.ts +1 -1
- package/dist-types/commands/ListIAMPolicyAssignmentsForUserCommand.d.ts +1 -1
- package/dist-types/commands/RegisterUserCommand.d.ts +1 -2
- package/dist-types/commands/TagResourceCommand.d.ts +8 -7
- package/dist-types/commands/UpdateDashboardCommand.d.ts +3 -1
- package/dist-types/commands/UpdateDataSetCommand.d.ts +1 -1
- package/dist-types/commands/UpdateIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateIpRestrictionCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +185 -250
- package/dist-types/models/models_1.d.ts +213 -113
- package/dist-types/runtimeConfig.browser.d.ts +3 -2
- package/dist-types/runtimeConfig.d.ts +4 -3
- package/dist-types/runtimeConfig.native.d.ts +1 -0
- package/dist-types/ts3.4/QuickSightClient.d.ts +3 -1
- package/dist-types/ts3.4/models/models_0.d.ts +76 -87
- package/dist-types/ts3.4/models/models_1.d.ts +43 -21
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +3 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +4 -3
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -0
- package/package.json +38 -45
|
@@ -1,5 +1,109 @@
|
|
|
1
1
|
import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
|
|
2
|
-
import { _Parameters, AccountCustomization, ActiveIAMPolicyAssignment, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, AssignmentStatus, ColumnGroup, ColumnLevelPermissionRule, DashboardPublishOptions, DashboardSearchFilter, DashboardSourceEntity, DashboardSummary, DashboardVersionSummary, DataSetImportMode, DataSetSummary, DataSetUsageConfiguration, DataSource, DataSourceCredentials, DataSourceParameters, FieldFolder, FilterOperator, FolderType, Group, GroupMember, IdentityType, Ingestion, LogicalTable, NamespaceInfoV2, PhysicalTable, ResourcePermission, ResourceStatus, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SslProperties, Tag, TemplateAlias, TemplateSourceEntity, ThemeAlias, ThemeConfiguration, ThemeType,
|
|
2
|
+
import { _Parameters, AccountCustomization, ActiveIAMPolicyAssignment, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, AssignmentStatus, ColumnGroup, ColumnLevelPermissionRule, DashboardPublishOptions, DashboardSearchFilter, DashboardSourceEntity, DashboardSummary, DashboardVersionSummary, DataSetImportMode, DataSetSummary, DataSetUsageConfiguration, DataSource, DataSourceCredentials, DataSourceParameters, FieldFolder, FilterOperator, FolderType, Group, GroupMember, IdentityType, Ingestion, LinkSharingConfiguration, LogicalTable, NamespaceInfoV2, PhysicalTable, ResourcePermission, ResourceStatus, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SslProperties, Tag, TemplateAlias, TemplateSourceEntity, ThemeAlias, ThemeConfiguration, ThemeType, VpcConnectionProperties } from "./models_0";
|
|
3
|
+
export declare enum UserRole {
|
|
4
|
+
ADMIN = "ADMIN",
|
|
5
|
+
AUTHOR = "AUTHOR",
|
|
6
|
+
READER = "READER",
|
|
7
|
+
RESTRICTED_AUTHOR = "RESTRICTED_AUTHOR",
|
|
8
|
+
RESTRICTED_READER = "RESTRICTED_READER"
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* <p>A registered user of Amazon QuickSight. </p>
|
|
12
|
+
*/
|
|
13
|
+
export interface User {
|
|
14
|
+
/**
|
|
15
|
+
* <p>The Amazon Resource Name (ARN) for the user.</p>
|
|
16
|
+
*/
|
|
17
|
+
Arn?: string;
|
|
18
|
+
/**
|
|
19
|
+
* <p>The user's user name. In the output, the value for <code>UserName</code> is
|
|
20
|
+
* <code>N/A</code> when the value for <code>IdentityType</code> is <code>IAM</code>
|
|
21
|
+
* and the corresponding IAM user is deleted.</p>
|
|
22
|
+
*/
|
|
23
|
+
UserName?: string;
|
|
24
|
+
/**
|
|
25
|
+
* <p>The user's email address.</p>
|
|
26
|
+
*/
|
|
27
|
+
Email?: string;
|
|
28
|
+
/**
|
|
29
|
+
* <p>The Amazon QuickSight role for the user. The user role can be one of the
|
|
30
|
+
* following:.</p>
|
|
31
|
+
* <ul>
|
|
32
|
+
* <li>
|
|
33
|
+
* <p>
|
|
34
|
+
* <code>READER</code>: A user who has read-only access to dashboards.</p>
|
|
35
|
+
* </li>
|
|
36
|
+
* <li>
|
|
37
|
+
* <p>
|
|
38
|
+
* <code>AUTHOR</code>: A user who can create data sources, datasets, analyses,
|
|
39
|
+
* and dashboards.</p>
|
|
40
|
+
* </li>
|
|
41
|
+
* <li>
|
|
42
|
+
* <p>
|
|
43
|
+
* <code>ADMIN</code>: A user who is an author, who can also manage Amazon
|
|
44
|
+
* Amazon QuickSight settings.</p>
|
|
45
|
+
* </li>
|
|
46
|
+
* <li>
|
|
47
|
+
* <p>
|
|
48
|
+
* <code>RESTRICTED_READER</code>: This role isn't currently available for
|
|
49
|
+
* use.</p>
|
|
50
|
+
* </li>
|
|
51
|
+
* <li>
|
|
52
|
+
* <p>
|
|
53
|
+
* <code>RESTRICTED_AUTHOR</code>: This role isn't currently available for
|
|
54
|
+
* use.</p>
|
|
55
|
+
* </li>
|
|
56
|
+
* </ul>
|
|
57
|
+
*/
|
|
58
|
+
Role?: UserRole | string;
|
|
59
|
+
/**
|
|
60
|
+
* <p>The type of identity authentication used by the user.</p>
|
|
61
|
+
*/
|
|
62
|
+
IdentityType?: IdentityType | string;
|
|
63
|
+
/**
|
|
64
|
+
* <p>The active status of user. When you create an Amazon QuickSight user that’s not an IAM
|
|
65
|
+
* user or an Active Directory user, that user is inactive until they sign in and provide a
|
|
66
|
+
* password.</p>
|
|
67
|
+
*/
|
|
68
|
+
Active?: boolean;
|
|
69
|
+
/**
|
|
70
|
+
* <p>The principal ID of the user.</p>
|
|
71
|
+
*/
|
|
72
|
+
PrincipalId?: string;
|
|
73
|
+
/**
|
|
74
|
+
* <p>The custom permissions profile associated with this user.</p>
|
|
75
|
+
*/
|
|
76
|
+
CustomPermissionsName?: string;
|
|
77
|
+
/**
|
|
78
|
+
* <p>The type of supported external login provider that provides identity to let the user
|
|
79
|
+
* federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.</p>
|
|
80
|
+
* <ul>
|
|
81
|
+
* <li>
|
|
82
|
+
* <p>
|
|
83
|
+
* <code>COGNITO</code>: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.</p>
|
|
84
|
+
* </li>
|
|
85
|
+
* <li>
|
|
86
|
+
* <p>
|
|
87
|
+
* <code>CUSTOM_OIDC</code>: Custom OpenID Connect (OIDC) provider.</p>
|
|
88
|
+
* </li>
|
|
89
|
+
* </ul>
|
|
90
|
+
*/
|
|
91
|
+
ExternalLoginFederationProviderType?: string;
|
|
92
|
+
/**
|
|
93
|
+
* <p>The URL of the external login provider.</p>
|
|
94
|
+
*/
|
|
95
|
+
ExternalLoginFederationProviderUrl?: string;
|
|
96
|
+
/**
|
|
97
|
+
* <p>The identity ID for the user in the external login provider.</p>
|
|
98
|
+
*/
|
|
99
|
+
ExternalLoginId?: string;
|
|
100
|
+
}
|
|
101
|
+
export declare namespace User {
|
|
102
|
+
/**
|
|
103
|
+
* @internal
|
|
104
|
+
*/
|
|
105
|
+
const filterSensitiveLog: (obj: User) => any;
|
|
106
|
+
}
|
|
3
107
|
export interface DescribeUserResponse {
|
|
4
108
|
/**
|
|
5
109
|
* <p>The user name.</p>
|
|
@@ -33,12 +137,6 @@ export interface DomainNotWhitelistedException extends __SmithyException, $Metad
|
|
|
33
137
|
*/
|
|
34
138
|
RequestId?: string;
|
|
35
139
|
}
|
|
36
|
-
export declare namespace DomainNotWhitelistedException {
|
|
37
|
-
/**
|
|
38
|
-
* @internal
|
|
39
|
-
*/
|
|
40
|
-
const filterSensitiveLog: (obj: DomainNotWhitelistedException) => any;
|
|
41
|
-
}
|
|
42
140
|
export declare enum EmbeddingIdentityType {
|
|
43
141
|
ANONYMOUS = "ANONYMOUS",
|
|
44
142
|
IAM = "IAM",
|
|
@@ -48,7 +146,7 @@ export declare enum FolderFilterAttribute {
|
|
|
48
146
|
PARENT_FOLDER_ARN = "PARENT_FOLDER_ARN"
|
|
49
147
|
}
|
|
50
148
|
/**
|
|
51
|
-
* <p>An object that consists of
|
|
149
|
+
* <p>An object that consists of a member Amazon Resource Name (ARN) and a member ID.</p>
|
|
52
150
|
*/
|
|
53
151
|
export interface MemberIdArnPair {
|
|
54
152
|
/**
|
|
@@ -67,15 +165,15 @@ export declare namespace MemberIdArnPair {
|
|
|
67
165
|
const filterSensitiveLog: (obj: MemberIdArnPair) => any;
|
|
68
166
|
}
|
|
69
167
|
/**
|
|
70
|
-
* <p>
|
|
168
|
+
* <p>A filter to use to search a Amazon QuickSight folder.</p>
|
|
71
169
|
*/
|
|
72
170
|
export interface FolderSearchFilter {
|
|
73
171
|
/**
|
|
74
|
-
* <p>The comparison operator that you want to use
|
|
172
|
+
* <p>The comparison operator that you want to use in the filter. For example, <code>"Operator": "StringEquals"</code>.</p>
|
|
75
173
|
*/
|
|
76
174
|
Operator?: FilterOperator | string;
|
|
77
175
|
/**
|
|
78
|
-
* <p>The name of
|
|
176
|
+
* <p>The name of a value that you want to use in the filter. For example, <code>"Name": "PARENT_FOLDER_ARN"</code>.</p>
|
|
79
177
|
*/
|
|
80
178
|
Name?: FolderFilterAttribute | string;
|
|
81
179
|
/**
|
|
@@ -90,15 +188,15 @@ export declare namespace FolderSearchFilter {
|
|
|
90
188
|
const filterSensitiveLog: (obj: FolderSearchFilter) => any;
|
|
91
189
|
}
|
|
92
190
|
/**
|
|
93
|
-
* <p>A summary of
|
|
191
|
+
* <p>A summary of information about an existing Amazon QuickSight folder. </p>
|
|
94
192
|
*/
|
|
95
193
|
export interface FolderSummary {
|
|
96
194
|
/**
|
|
97
|
-
* <p>The Amazon Resource Name (ARN).</p>
|
|
195
|
+
* <p>The Amazon Resource Name (ARN) of the folder.</p>
|
|
98
196
|
*/
|
|
99
197
|
Arn?: string;
|
|
100
198
|
/**
|
|
101
|
-
* <p>The folder
|
|
199
|
+
* <p>The ID of the folder.</p>
|
|
102
200
|
*/
|
|
103
201
|
FolderId?: string;
|
|
104
202
|
/**
|
|
@@ -210,19 +308,15 @@ export interface SessionLifetimeInMinutesInvalidException extends __SmithyExcept
|
|
|
210
308
|
*/
|
|
211
309
|
RequestId?: string;
|
|
212
310
|
}
|
|
213
|
-
export declare namespace SessionLifetimeInMinutesInvalidException {
|
|
214
|
-
/**
|
|
215
|
-
* @internal
|
|
216
|
-
*/
|
|
217
|
-
const filterSensitiveLog: (obj: SessionLifetimeInMinutesInvalidException) => any;
|
|
218
|
-
}
|
|
219
311
|
/**
|
|
220
312
|
* <p>This error indicates that you are calling an embedding operation in Amazon QuickSight
|
|
221
313
|
* without the required pricing plan on your Amazon Web Services account. Before you can use embedding
|
|
222
|
-
* for anonymous users, a
|
|
314
|
+
* for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You
|
|
223
315
|
* can do this on the <b>Manage Amazon QuickSight</b> page. </p>
|
|
224
316
|
* <p>After capacity pricing is added, you can use the
|
|
225
|
-
* <
|
|
317
|
+
* <code>
|
|
318
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GetDashboardEmbedUrl.html">GetDashboardEmbedUrl</a>
|
|
319
|
+
* </code> API operation with the
|
|
226
320
|
* <code>--identity-type ANONYMOUS</code> option.</p>
|
|
227
321
|
*/
|
|
228
322
|
export interface UnsupportedPricingPlanException extends __SmithyException, $MetadataBearer {
|
|
@@ -234,12 +328,6 @@ export interface UnsupportedPricingPlanException extends __SmithyException, $Met
|
|
|
234
328
|
*/
|
|
235
329
|
RequestId?: string;
|
|
236
330
|
}
|
|
237
|
-
export declare namespace UnsupportedPricingPlanException {
|
|
238
|
-
/**
|
|
239
|
-
* @internal
|
|
240
|
-
*/
|
|
241
|
-
const filterSensitiveLog: (obj: UnsupportedPricingPlanException) => any;
|
|
242
|
-
}
|
|
243
331
|
/**
|
|
244
332
|
* <p>Information about the dashboard you want to embed.</p>
|
|
245
333
|
*/
|
|
@@ -261,8 +349,12 @@ export declare namespace RegisteredUserDashboardEmbeddingConfiguration {
|
|
|
261
349
|
*/
|
|
262
350
|
export interface RegisteredUserQSearchBarEmbeddingConfiguration {
|
|
263
351
|
/**
|
|
264
|
-
* <p>The ID of the Q topic that you want to make the starting topic in the Q search bar.
|
|
265
|
-
*
|
|
352
|
+
* <p>The ID of the Q topic that you want to make the starting topic in the Q search bar.
|
|
353
|
+
* You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening
|
|
354
|
+
* a topic. The ID is in the URL for the topic that you open.</p>
|
|
355
|
+
* <p>If you don't specify an initial topic, a list of all shared topics is shown in the Q bar
|
|
356
|
+
* for your readers. When you select an initial topic, you can specify whether or not readers
|
|
357
|
+
* are allowed to select other topics from the available ones in the list.</p>
|
|
266
358
|
*/
|
|
267
359
|
InitialTopicId?: string;
|
|
268
360
|
}
|
|
@@ -319,9 +411,11 @@ export declare namespace RegisteredUserQuickSightConsoleEmbeddingConfiguration {
|
|
|
319
411
|
const filterSensitiveLog: (obj: RegisteredUserQuickSightConsoleEmbeddingConfiguration) => any;
|
|
320
412
|
}
|
|
321
413
|
/**
|
|
322
|
-
* <p>The type of experience you want to embed. For registered users, you can embed
|
|
414
|
+
* <p>The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console.</p>
|
|
323
415
|
* <note>
|
|
324
|
-
* <p>Exactly one of the experience configurations is required. You can choose
|
|
416
|
+
* <p>Exactly one of the experience configurations is required. You can choose
|
|
417
|
+
* <code>Dashboard</code> or <code>QuickSightConsole</code>. You cannot choose more
|
|
418
|
+
* than one experience configuration.</p>
|
|
325
419
|
* </note>
|
|
326
420
|
*/
|
|
327
421
|
export interface RegisteredUserEmbeddingExperienceConfiguration {
|
|
@@ -330,17 +424,20 @@ export interface RegisteredUserEmbeddingExperienceConfiguration {
|
|
|
330
424
|
*/
|
|
331
425
|
Dashboard?: RegisteredUserDashboardEmbeddingConfiguration;
|
|
332
426
|
/**
|
|
333
|
-
* <p>The configuration details for providing
|
|
427
|
+
* <p>The configuration details for providing each Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html">Customizing Access to the Amazon QuickSight Console</a> in the <i>Amazon QuickSight User
|
|
334
428
|
* Guide</i>.</p>
|
|
335
|
-
* <p>Use <code>
|
|
429
|
+
* <p>Use <code>
|
|
430
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForRegisteredUser.html">GenerateEmbedUrlForRegisteredUser</a>
|
|
431
|
+
* </code>
|
|
432
|
+
* where
|
|
336
433
|
* you want to provide an authoring portal that allows users to create data sources,
|
|
337
434
|
* datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console
|
|
338
435
|
* needs to belong to the author or admin security cohort. If you want to restrict permissions
|
|
339
436
|
* to some of these features, add a custom permissions profile to the user with the
|
|
340
437
|
* <code>
|
|
341
|
-
* <a>UpdateUser</a>
|
|
342
|
-
* </code> API operation. Use <code>
|
|
343
|
-
* <a>RegisterUser</a>
|
|
438
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html">UpdateUser</a>
|
|
439
|
+
* </code> API operation. Use the <code>
|
|
440
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html">RegisterUser</a>
|
|
344
441
|
* </code> API operation to add a new user with a custom permission profile attached. For more
|
|
345
442
|
* information, see the following sections in the <i>Amazon QuickSight User
|
|
346
443
|
* Guide</i>:</p>
|
|
@@ -361,7 +458,8 @@ export interface RegisteredUserEmbeddingExperienceConfiguration {
|
|
|
361
458
|
QuickSightConsole?: RegisteredUserQuickSightConsoleEmbeddingConfiguration;
|
|
362
459
|
/**
|
|
363
460
|
* <p>The configuration details for embedding the Q search bar.</p>
|
|
364
|
-
* <p>For more information about embedding the Q search bar, see
|
|
461
|
+
* <p>For more information about embedding the Q search bar, see
|
|
462
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html">Embedding Overview</a>.</p>
|
|
365
463
|
*/
|
|
366
464
|
QSearchBar?: RegisteredUserQSearchBarEmbeddingConfiguration;
|
|
367
465
|
}
|
|
@@ -385,7 +483,7 @@ export interface GenerateEmbedUrlForRegisteredUserRequest {
|
|
|
385
483
|
*/
|
|
386
484
|
UserArn: string | undefined;
|
|
387
485
|
/**
|
|
388
|
-
* <p>The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards
|
|
486
|
+
* <p>The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards or the entire Amazon QuickSight console.</p>
|
|
389
487
|
*/
|
|
390
488
|
ExperienceConfiguration: RegisteredUserEmbeddingExperienceConfiguration | undefined;
|
|
391
489
|
}
|
|
@@ -397,7 +495,7 @@ export declare namespace GenerateEmbedUrlForRegisteredUserRequest {
|
|
|
397
495
|
}
|
|
398
496
|
export interface GenerateEmbedUrlForRegisteredUserResponse {
|
|
399
497
|
/**
|
|
400
|
-
* <p>The embed URL for the Amazon QuickSight dashboard
|
|
498
|
+
* <p>The embed URL for the Amazon QuickSight dashboard or console.</p>
|
|
401
499
|
*/
|
|
402
500
|
EmbedUrl: string | undefined;
|
|
403
501
|
/**
|
|
@@ -429,12 +527,6 @@ export interface QuickSightUserNotFoundException extends __SmithyException, $Met
|
|
|
429
527
|
*/
|
|
430
528
|
RequestId?: string;
|
|
431
529
|
}
|
|
432
|
-
export declare namespace QuickSightUserNotFoundException {
|
|
433
|
-
/**
|
|
434
|
-
* @internal
|
|
435
|
-
*/
|
|
436
|
-
const filterSensitiveLog: (obj: QuickSightUserNotFoundException) => any;
|
|
437
|
-
}
|
|
438
530
|
export interface GetDashboardEmbedUrlRequest {
|
|
439
531
|
/**
|
|
440
532
|
* <p>The ID for the Amazon Web Services account that contains the dashboard that you're embedding.</p>
|
|
@@ -485,11 +577,11 @@ export interface GetDashboardEmbedUrlRequest {
|
|
|
485
577
|
* <p>Invited nonfederated users</p>
|
|
486
578
|
* </li>
|
|
487
579
|
* <li>
|
|
488
|
-
* <p>
|
|
489
|
-
* SAML, OpenID Connect, or
|
|
580
|
+
* <p>IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using
|
|
581
|
+
* SAML, OpenID Connect, or IAM federation.</p>
|
|
490
582
|
* </li>
|
|
491
583
|
* </ul>
|
|
492
|
-
* <p>Omit this parameter for users in the third group –
|
|
584
|
+
* <p>Omit this parameter for users in the third group – IAM users and IAM
|
|
493
585
|
* role-based sessions.</p>
|
|
494
586
|
*/
|
|
495
587
|
UserArn?: string;
|
|
@@ -502,7 +594,7 @@ export interface GetDashboardEmbedUrlRequest {
|
|
|
502
594
|
* <p>A list of one or more dashboard IDs that you want to add to a session that includes
|
|
503
595
|
* anonymous users. The <code>IdentityType</code> parameter must be set to
|
|
504
596
|
* <code>ANONYMOUS</code> for this to work, because other identity types authenticate
|
|
505
|
-
* as Amazon QuickSight or
|
|
597
|
+
* as Amazon QuickSight or IAM users. For example, if you set "<code>--dashboard-id dash_id1
|
|
506
598
|
* --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS</code>", the session
|
|
507
599
|
* can access all three dashboards. </p>
|
|
508
600
|
*/
|
|
@@ -553,12 +645,6 @@ export interface IdentityTypeNotSupportedException extends __SmithyException, $M
|
|
|
553
645
|
*/
|
|
554
646
|
RequestId?: string;
|
|
555
647
|
}
|
|
556
|
-
export declare namespace IdentityTypeNotSupportedException {
|
|
557
|
-
/**
|
|
558
|
-
* @internal
|
|
559
|
-
*/
|
|
560
|
-
const filterSensitiveLog: (obj: IdentityTypeNotSupportedException) => any;
|
|
561
|
-
}
|
|
562
648
|
export interface GetSessionEmbedUrlRequest {
|
|
563
649
|
/**
|
|
564
650
|
* <p>The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.</p>
|
|
@@ -657,7 +743,7 @@ export declare namespace GetSessionEmbedUrlResponse {
|
|
|
657
743
|
const filterSensitiveLog: (obj: GetSessionEmbedUrlResponse) => any;
|
|
658
744
|
}
|
|
659
745
|
/**
|
|
660
|
-
* <p>
|
|
746
|
+
* <p>IAM policy assignment summary.</p>
|
|
661
747
|
*/
|
|
662
748
|
export interface IAMPolicyAssignmentSummary {
|
|
663
749
|
/**
|
|
@@ -904,11 +990,11 @@ export declare namespace ListDataSourcesResponse {
|
|
|
904
990
|
}
|
|
905
991
|
export interface ListFolderMembersRequest {
|
|
906
992
|
/**
|
|
907
|
-
* <p>The
|
|
993
|
+
* <p>The ID for the Amazon Web Services account that contains the folder.</p>
|
|
908
994
|
*/
|
|
909
995
|
AwsAccountId: string | undefined;
|
|
910
996
|
/**
|
|
911
|
-
* <p>The folder
|
|
997
|
+
* <p>The ID of the folder.</p>
|
|
912
998
|
*/
|
|
913
999
|
FolderId: string | undefined;
|
|
914
1000
|
/**
|
|
@@ -928,8 +1014,7 @@ export declare namespace ListFolderMembersRequest {
|
|
|
928
1014
|
}
|
|
929
1015
|
export interface ListFolderMembersResponse {
|
|
930
1016
|
/**
|
|
931
|
-
* <p>The status
|
|
932
|
-
* </p>
|
|
1017
|
+
* <p>The HTTP status of the request.</p>
|
|
933
1018
|
*/
|
|
934
1019
|
Status?: number;
|
|
935
1020
|
/**
|
|
@@ -941,7 +1026,7 @@ export interface ListFolderMembersResponse {
|
|
|
941
1026
|
*/
|
|
942
1027
|
NextToken?: string;
|
|
943
1028
|
/**
|
|
944
|
-
* <p>The request ID.</p>
|
|
1029
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
945
1030
|
*/
|
|
946
1031
|
RequestId?: string;
|
|
947
1032
|
}
|
|
@@ -953,7 +1038,7 @@ export declare namespace ListFolderMembersResponse {
|
|
|
953
1038
|
}
|
|
954
1039
|
export interface ListFoldersRequest {
|
|
955
1040
|
/**
|
|
956
|
-
* <p>The
|
|
1041
|
+
* <p>The ID for the Amazon Web Services account that contains the folder.</p>
|
|
957
1042
|
*/
|
|
958
1043
|
AwsAccountId: string | undefined;
|
|
959
1044
|
/**
|
|
@@ -973,12 +1058,11 @@ export declare namespace ListFoldersRequest {
|
|
|
973
1058
|
}
|
|
974
1059
|
export interface ListFoldersResponse {
|
|
975
1060
|
/**
|
|
976
|
-
* <p>The status
|
|
977
|
-
* </p>
|
|
1061
|
+
* <p>The HTTP status of the request.</p>
|
|
978
1062
|
*/
|
|
979
1063
|
Status?: number;
|
|
980
1064
|
/**
|
|
981
|
-
* <p>A structure that contains all of the folders in
|
|
1065
|
+
* <p>A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.</p>
|
|
982
1066
|
*/
|
|
983
1067
|
FolderSummaryList?: FolderSummary[];
|
|
984
1068
|
/**
|
|
@@ -986,7 +1070,7 @@ export interface ListFoldersResponse {
|
|
|
986
1070
|
*/
|
|
987
1071
|
NextToken?: string;
|
|
988
1072
|
/**
|
|
989
|
-
* <p>The request ID.</p>
|
|
1073
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
990
1074
|
*/
|
|
991
1075
|
RequestId?: string;
|
|
992
1076
|
}
|
|
@@ -1100,7 +1184,7 @@ export declare namespace ListGroupsResponse {
|
|
|
1100
1184
|
}
|
|
1101
1185
|
export interface ListIAMPolicyAssignmentsRequest {
|
|
1102
1186
|
/**
|
|
1103
|
-
* <p>The ID of the Amazon Web Services account that contains these
|
|
1187
|
+
* <p>The ID of the Amazon Web Services account that contains these IAM policy assignments.</p>
|
|
1104
1188
|
*/
|
|
1105
1189
|
AwsAccountId: string | undefined;
|
|
1106
1190
|
/**
|
|
@@ -1128,7 +1212,7 @@ export declare namespace ListIAMPolicyAssignmentsRequest {
|
|
|
1128
1212
|
}
|
|
1129
1213
|
export interface ListIAMPolicyAssignmentsResponse {
|
|
1130
1214
|
/**
|
|
1131
|
-
* <p>Information describing the
|
|
1215
|
+
* <p>Information describing the IAM policy assignments.</p>
|
|
1132
1216
|
*/
|
|
1133
1217
|
IAMPolicyAssignments?: IAMPolicyAssignmentSummary[];
|
|
1134
1218
|
/**
|
|
@@ -1868,7 +1952,7 @@ export interface RegisterUserRequest {
|
|
|
1868
1952
|
* <ul>
|
|
1869
1953
|
* <li>
|
|
1870
1954
|
* <p>
|
|
1871
|
-
* <code>IAM</code>: A user whose identity maps to an existing
|
|
1955
|
+
* <code>IAM</code>: A user whose identity maps to an existing IAM user or role.
|
|
1872
1956
|
* </p>
|
|
1873
1957
|
* </li>
|
|
1874
1958
|
* <li>
|
|
@@ -1915,17 +1999,17 @@ export interface RegisterUserRequest {
|
|
|
1915
1999
|
*/
|
|
1916
2000
|
UserRole: UserRole | string | undefined;
|
|
1917
2001
|
/**
|
|
1918
|
-
* <p>The ARN of the
|
|
2002
|
+
* <p>The ARN of the IAM user or role that you are registering with Amazon QuickSight. </p>
|
|
1919
2003
|
*/
|
|
1920
2004
|
IamArn?: string;
|
|
1921
2005
|
/**
|
|
1922
2006
|
* <p>You need to use this parameter only when you register one or more users using an assumed
|
|
1923
|
-
*
|
|
1924
|
-
* you are registering an
|
|
1925
|
-
* users using the same
|
|
1926
|
-
* information on assuming
|
|
2007
|
+
* IAM role. You don't need to provide the session name for other scenarios, for example when
|
|
2008
|
+
* you are registering an IAM user or an Amazon QuickSight user. You can register multiple
|
|
2009
|
+
* users using the same IAM role if each user has a different session name. For more
|
|
2010
|
+
* information on assuming IAM roles, see <a href="https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html">
|
|
1927
2011
|
* <code>assume-role</code>
|
|
1928
|
-
* </a> in the <i>
|
|
2012
|
+
* </a> in the <i>CLI Reference.</i>
|
|
1929
2013
|
* </p>
|
|
1930
2014
|
*/
|
|
1931
2015
|
SessionName?: string;
|
|
@@ -1962,13 +2046,13 @@ export interface RegisterUserRequest {
|
|
|
1962
2046
|
* </li>
|
|
1963
2047
|
* </ul>
|
|
1964
2048
|
* <p>To add custom permissions to an existing user, use <code>
|
|
1965
|
-
* <a>UpdateUser</a>
|
|
2049
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html">UpdateUser</a>
|
|
1966
2050
|
* </code> instead.</p>
|
|
1967
2051
|
* <p>A set of custom permissions includes any combination of these restrictions. Currently,
|
|
1968
2052
|
* you need to create the profile names for custom permission sets by using the Amazon QuickSight
|
|
1969
2053
|
* console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of
|
|
1970
|
-
* permissions to a
|
|
1971
|
-
* <p>Amazon QuickSight custom permissions are applied through
|
|
2054
|
+
* permissions to a QuickSight user. </p>
|
|
2055
|
+
* <p>Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they
|
|
1972
2056
|
* override the permissions typically granted by assigning Amazon QuickSight users to one of the
|
|
1973
2057
|
* default security cohorts in Amazon QuickSight (admin, author, reader).</p>
|
|
1974
2058
|
* <p>This feature is available only to Amazon QuickSight Enterprise edition subscriptions.</p>
|
|
@@ -2176,7 +2260,7 @@ export declare namespace SearchDashboardsResponse {
|
|
|
2176
2260
|
}
|
|
2177
2261
|
export interface SearchFoldersRequest {
|
|
2178
2262
|
/**
|
|
2179
|
-
* <p>The
|
|
2263
|
+
* <p>The ID for the Amazon Web Services account that contains the folder.</p>
|
|
2180
2264
|
*/
|
|
2181
2265
|
AwsAccountId: string | undefined;
|
|
2182
2266
|
/**
|
|
@@ -2200,11 +2284,11 @@ export declare namespace SearchFoldersRequest {
|
|
|
2200
2284
|
}
|
|
2201
2285
|
export interface SearchFoldersResponse {
|
|
2202
2286
|
/**
|
|
2203
|
-
* <p>The status
|
|
2287
|
+
* <p>The HTTP status of the request.</p>
|
|
2204
2288
|
*/
|
|
2205
2289
|
Status?: number;
|
|
2206
2290
|
/**
|
|
2207
|
-
* <p>A structure that contains all of the folders in
|
|
2291
|
+
* <p>A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.</p>
|
|
2208
2292
|
*/
|
|
2209
2293
|
FolderSummaryList?: FolderSummary[];
|
|
2210
2294
|
/**
|
|
@@ -2212,7 +2296,7 @@ export interface SearchFoldersResponse {
|
|
|
2212
2296
|
*/
|
|
2213
2297
|
NextToken?: string;
|
|
2214
2298
|
/**
|
|
2215
|
-
* <p>The request ID.</p>
|
|
2299
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2216
2300
|
*/
|
|
2217
2301
|
RequestId?: string;
|
|
2218
2302
|
}
|
|
@@ -2523,7 +2607,9 @@ export interface UpdateDashboardRequest {
|
|
|
2523
2607
|
* <code>SourceEntity</code>, you specify the type of object you're using as source. You
|
|
2524
2608
|
* can only update a dashboard from a template, so you use a <code>SourceTemplate</code>
|
|
2525
2609
|
* entity. If you need to update a dashboard from an analysis, first convert the analysis
|
|
2526
|
-
* to a template by using the <
|
|
2610
|
+
* to a template by using the <code>
|
|
2611
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a>
|
|
2612
|
+
* </code> API operation. For
|
|
2527
2613
|
* <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source
|
|
2528
2614
|
* template. The <code>SourceTemplate</code> ARN can contain any Amazon Web Services account and any
|
|
2529
2615
|
* Amazon QuickSight-supported Amazon Web Services Region. </p>
|
|
@@ -2633,6 +2719,14 @@ export interface UpdateDashboardPermissionsRequest {
|
|
|
2633
2719
|
* <p>The permissions that you want to revoke from this resource.</p>
|
|
2634
2720
|
*/
|
|
2635
2721
|
RevokePermissions?: ResourcePermission[];
|
|
2722
|
+
/**
|
|
2723
|
+
* <p>Grants link permissions to all users in a defined namespace.</p>
|
|
2724
|
+
*/
|
|
2725
|
+
GrantLinkPermissions?: ResourcePermission[];
|
|
2726
|
+
/**
|
|
2727
|
+
* <p>Revokes link permissions from all users in a defined namespace.</p>
|
|
2728
|
+
*/
|
|
2729
|
+
RevokeLinkPermissions?: ResourcePermission[];
|
|
2636
2730
|
}
|
|
2637
2731
|
export declare namespace UpdateDashboardPermissionsRequest {
|
|
2638
2732
|
/**
|
|
@@ -2661,6 +2755,10 @@ export interface UpdateDashboardPermissionsResponse {
|
|
|
2661
2755
|
* <p>The HTTP status of the request.</p>
|
|
2662
2756
|
*/
|
|
2663
2757
|
Status?: number;
|
|
2758
|
+
/**
|
|
2759
|
+
* <p>Updates the permissions of a shared link to an Amazon QuickSight dashboard.</p>
|
|
2760
|
+
*/
|
|
2761
|
+
LinkSharingConfiguration?: LinkSharingConfiguration;
|
|
2664
2762
|
}
|
|
2665
2763
|
export declare namespace UpdateDashboardPermissionsResponse {
|
|
2666
2764
|
/**
|
|
@@ -2763,7 +2861,7 @@ export interface UpdateDataSetRequest {
|
|
|
2763
2861
|
RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration;
|
|
2764
2862
|
/**
|
|
2765
2863
|
* <p>A set of one or more definitions of a <code>
|
|
2766
|
-
* <a>ColumnLevelPermissionRule</a>
|
|
2864
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html">ColumnLevelPermissionRule</a>
|
|
2767
2865
|
* </code>.</p>
|
|
2768
2866
|
*/
|
|
2769
2867
|
ColumnLevelPermissionRules?: ColumnLevelPermissionRule[];
|
|
@@ -2979,11 +3077,11 @@ export declare namespace UpdateDataSourcePermissionsResponse {
|
|
|
2979
3077
|
}
|
|
2980
3078
|
export interface UpdateFolderRequest {
|
|
2981
3079
|
/**
|
|
2982
|
-
* <p>The
|
|
3080
|
+
* <p>The ID for the Amazon Web Services account that contains the folder to update.</p>
|
|
2983
3081
|
*/
|
|
2984
3082
|
AwsAccountId: string | undefined;
|
|
2985
3083
|
/**
|
|
2986
|
-
* <p>The folder
|
|
3084
|
+
* <p>The ID of the folder.</p>
|
|
2987
3085
|
*/
|
|
2988
3086
|
FolderId: string | undefined;
|
|
2989
3087
|
/**
|
|
@@ -2999,19 +3097,19 @@ export declare namespace UpdateFolderRequest {
|
|
|
2999
3097
|
}
|
|
3000
3098
|
export interface UpdateFolderResponse {
|
|
3001
3099
|
/**
|
|
3002
|
-
* <p>The status
|
|
3100
|
+
* <p>The HTTP status of the request.</p>
|
|
3003
3101
|
*/
|
|
3004
3102
|
Status?: number;
|
|
3005
3103
|
/**
|
|
3006
|
-
* <p>The Amazon Resource Name (ARN).</p>
|
|
3104
|
+
* <p>The Amazon Resource Name (ARN) of the folder.</p>
|
|
3007
3105
|
*/
|
|
3008
3106
|
Arn?: string;
|
|
3009
3107
|
/**
|
|
3010
|
-
* <p>The folder
|
|
3108
|
+
* <p>The ID of the folder.</p>
|
|
3011
3109
|
*/
|
|
3012
3110
|
FolderId?: string;
|
|
3013
3111
|
/**
|
|
3014
|
-
* <p>The request ID.</p>
|
|
3112
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
3015
3113
|
*/
|
|
3016
3114
|
RequestId?: string;
|
|
3017
3115
|
}
|
|
@@ -3023,11 +3121,11 @@ export declare namespace UpdateFolderResponse {
|
|
|
3023
3121
|
}
|
|
3024
3122
|
export interface UpdateFolderPermissionsRequest {
|
|
3025
3123
|
/**
|
|
3026
|
-
* <p>The
|
|
3124
|
+
* <p>The ID for the Amazon Web Services account that contains the folder to update.</p>
|
|
3027
3125
|
*/
|
|
3028
3126
|
AwsAccountId: string | undefined;
|
|
3029
3127
|
/**
|
|
3030
|
-
* <p>The folder
|
|
3128
|
+
* <p>The ID of the folder.</p>
|
|
3031
3129
|
*/
|
|
3032
3130
|
FolderId: string | undefined;
|
|
3033
3131
|
/**
|
|
@@ -3047,23 +3145,23 @@ export declare namespace UpdateFolderPermissionsRequest {
|
|
|
3047
3145
|
}
|
|
3048
3146
|
export interface UpdateFolderPermissionsResponse {
|
|
3049
3147
|
/**
|
|
3050
|
-
* <p>The status
|
|
3148
|
+
* <p>The HTTP status of the request.</p>
|
|
3051
3149
|
*/
|
|
3052
3150
|
Status?: number;
|
|
3053
3151
|
/**
|
|
3054
|
-
* <p>The Amazon Resource Name (ARN).</p>
|
|
3152
|
+
* <p>The Amazon Resource Name (ARN) of the folder.</p>
|
|
3055
3153
|
*/
|
|
3056
3154
|
Arn?: string;
|
|
3057
3155
|
/**
|
|
3058
|
-
* <p>The folder
|
|
3156
|
+
* <p>The ID of the folder.</p>
|
|
3059
3157
|
*/
|
|
3060
3158
|
FolderId?: string;
|
|
3061
3159
|
/**
|
|
3062
|
-
* <p>Information about the permissions
|
|
3160
|
+
* <p>Information about the permissions for the folder.</p>
|
|
3063
3161
|
*/
|
|
3064
3162
|
Permissions?: ResourcePermission[];
|
|
3065
3163
|
/**
|
|
3066
|
-
* <p>The request ID.</p>
|
|
3164
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
3067
3165
|
*/
|
|
3068
3166
|
RequestId?: string;
|
|
3069
3167
|
}
|
|
@@ -3120,7 +3218,7 @@ export declare namespace UpdateGroupResponse {
|
|
|
3120
3218
|
}
|
|
3121
3219
|
export interface UpdateIAMPolicyAssignmentRequest {
|
|
3122
3220
|
/**
|
|
3123
|
-
* <p>The ID of the Amazon Web Services account that contains the
|
|
3221
|
+
* <p>The ID of the Amazon Web Services account that contains the IAM policy assignment. </p>
|
|
3124
3222
|
*/
|
|
3125
3223
|
AwsAccountId: string | undefined;
|
|
3126
3224
|
/**
|
|
@@ -3152,7 +3250,7 @@ export interface UpdateIAMPolicyAssignmentRequest {
|
|
|
3152
3250
|
*/
|
|
3153
3251
|
AssignmentStatus?: AssignmentStatus | string;
|
|
3154
3252
|
/**
|
|
3155
|
-
* <p>The ARN for the
|
|
3253
|
+
* <p>The ARN for the IAM policy to apply to the Amazon QuickSight users and groups
|
|
3156
3254
|
* specified in this assignment.</p>
|
|
3157
3255
|
*/
|
|
3158
3256
|
PolicyArn?: string;
|
|
@@ -3179,12 +3277,12 @@ export interface UpdateIAMPolicyAssignmentResponse {
|
|
|
3179
3277
|
*/
|
|
3180
3278
|
AssignmentId?: string;
|
|
3181
3279
|
/**
|
|
3182
|
-
* <p>The ARN for the
|
|
3280
|
+
* <p>The ARN for the IAM policy applied to the Amazon QuickSight users and groups specified in this
|
|
3183
3281
|
* assignment.</p>
|
|
3184
3282
|
*/
|
|
3185
3283
|
PolicyArn?: string;
|
|
3186
3284
|
/**
|
|
3187
|
-
* <p>The Amazon QuickSight users, groups, or both that the
|
|
3285
|
+
* <p>The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.</p>
|
|
3188
3286
|
*/
|
|
3189
3287
|
Identities?: {
|
|
3190
3288
|
[key: string]: string[];
|
|
@@ -3226,17 +3324,17 @@ export declare namespace UpdateIAMPolicyAssignmentResponse {
|
|
|
3226
3324
|
}
|
|
3227
3325
|
export interface UpdateIpRestrictionRequest {
|
|
3228
3326
|
/**
|
|
3229
|
-
* <p>
|
|
3327
|
+
* <p>The ID of the Amazon Web Services account that contains the IP rules.</p>
|
|
3230
3328
|
*/
|
|
3231
3329
|
AwsAccountId: string | undefined;
|
|
3232
3330
|
/**
|
|
3233
|
-
* <p>
|
|
3331
|
+
* <p>A map that describes the updated IP rules with CIDR ranges and descriptions.</p>
|
|
3234
3332
|
*/
|
|
3235
3333
|
IpRestrictionRuleMap?: {
|
|
3236
3334
|
[key: string]: string;
|
|
3237
3335
|
};
|
|
3238
3336
|
/**
|
|
3239
|
-
* <p>
|
|
3337
|
+
* <p>A value that specifies whether IP rules are turned on.</p>
|
|
3240
3338
|
*/
|
|
3241
3339
|
Enabled?: boolean;
|
|
3242
3340
|
}
|
|
@@ -3248,15 +3346,15 @@ export declare namespace UpdateIpRestrictionRequest {
|
|
|
3248
3346
|
}
|
|
3249
3347
|
export interface UpdateIpRestrictionResponse {
|
|
3250
3348
|
/**
|
|
3251
|
-
* <p>
|
|
3349
|
+
* <p>The ID of the Amazon Web Services account that contains the IP rules.</p>
|
|
3252
3350
|
*/
|
|
3253
3351
|
AwsAccountId?: string;
|
|
3254
3352
|
/**
|
|
3255
|
-
* <p>The ID
|
|
3353
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
3256
3354
|
*/
|
|
3257
3355
|
RequestId?: string;
|
|
3258
3356
|
/**
|
|
3259
|
-
* <p>The status of the
|
|
3357
|
+
* <p>The HTTP status of the request. </p>
|
|
3260
3358
|
*/
|
|
3261
3359
|
Status?: number;
|
|
3262
3360
|
}
|
|
@@ -3662,8 +3760,8 @@ export interface UpdateUserRequest {
|
|
|
3662
3760
|
* <p>A set of custom permissions includes any combination of these restrictions. Currently,
|
|
3663
3761
|
* you need to create the profile names for custom permission sets by using the Amazon QuickSight
|
|
3664
3762
|
* console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of
|
|
3665
|
-
* permissions to a
|
|
3666
|
-
* <p>Amazon QuickSight custom permissions are applied through
|
|
3763
|
+
* permissions to a QuickSight user. </p>
|
|
3764
|
+
* <p>Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they
|
|
3667
3765
|
* override the permissions typically granted by assigning Amazon QuickSight users to one of the
|
|
3668
3766
|
* default security cohorts in Amazon QuickSight (admin, author, reader).</p>
|
|
3669
3767
|
* <p>This feature is available only to Amazon QuickSight Enterprise edition subscriptions.</p>
|
|
@@ -3689,9 +3787,11 @@ export interface UpdateUserRequest {
|
|
|
3689
3787
|
* </li>
|
|
3690
3788
|
* <li>
|
|
3691
3789
|
* <p>
|
|
3692
|
-
* <code>NONE</code>: This clears all the previously saved external login information for a user. Use
|
|
3693
|
-
*
|
|
3694
|
-
*
|
|
3790
|
+
* <code>NONE</code>: This clears all the previously saved external login information for a user. Use the
|
|
3791
|
+
* <code>
|
|
3792
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeUser.html">DescribeUser</a>
|
|
3793
|
+
* </code>
|
|
3794
|
+
* API operation to check the external login information.</p>
|
|
3695
3795
|
* </li>
|
|
3696
3796
|
* </ul>
|
|
3697
3797
|
*/
|