@aws-sdk/client-quicksight 3.28.0 → 3.32.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 +38 -0
- package/QuickSight.ts +59 -59
- package/commands/CreateAccountCustomizationCommand.ts +4 -4
- package/commands/CreateDashboardCommand.ts +3 -3
- package/commands/CreateIAMPolicyAssignmentCommand.ts +2 -2
- package/commands/CreateNamespaceCommand.ts +4 -4
- package/commands/CreateTemplateCommand.ts +1 -1
- package/commands/DeleteAccountCustomizationCommand.ts +1 -1
- package/commands/DeleteAnalysisCommand.ts +3 -3
- package/commands/DeleteIAMPolicyAssignmentCommand.ts +1 -1
- package/commands/DescribeAccountCustomizationCommand.ts +12 -12
- package/commands/DescribeAccountSettingsCommand.ts +2 -2
- package/commands/DescribeIAMPolicyAssignmentCommand.ts +1 -1
- package/commands/GetDashboardEmbedUrlCommand.ts +1 -1
- package/commands/GetSessionEmbedUrlCommand.ts +3 -3
- package/commands/ListAnalysesCommand.ts +1 -1
- package/commands/ListDashboardVersionsCommand.ts +1 -1
- package/commands/ListDashboardsCommand.ts +1 -1
- package/commands/ListDataSetsCommand.ts +1 -1
- package/commands/ListDataSourcesCommand.ts +1 -1
- package/commands/ListIAMPolicyAssignmentsCommand.ts +1 -1
- package/commands/ListIAMPolicyAssignmentsForUserCommand.ts +1 -1
- package/commands/ListNamespacesCommand.ts +1 -1
- package/commands/ListThemeVersionsCommand.ts +1 -1
- package/commands/ListThemesCommand.ts +1 -1
- package/commands/TagResourceCommand.ts +5 -5
- package/commands/UpdateAccountCustomizationCommand.ts +3 -3
- package/commands/UpdateAccountSettingsCommand.ts +1 -1
- package/commands/UpdateDashboardCommand.ts +1 -1
- package/commands/UpdateIAMPolicyAssignmentCommand.ts +1 -1
- package/dist/cjs/commands/CreateAccountCustomizationCommand.js +4 -4
- package/dist/cjs/commands/CreateDashboardCommand.js +3 -3
- package/dist/cjs/commands/CreateIAMPolicyAssignmentCommand.js +2 -2
- package/dist/cjs/commands/CreateNamespaceCommand.js +4 -4
- package/dist/cjs/commands/CreateTemplateCommand.js +1 -1
- package/dist/cjs/commands/DeleteAccountCustomizationCommand.js +1 -1
- package/dist/cjs/commands/DeleteAnalysisCommand.js +3 -3
- package/dist/cjs/commands/DeleteIAMPolicyAssignmentCommand.js +1 -1
- package/dist/cjs/commands/DescribeAccountCustomizationCommand.js +12 -12
- package/dist/cjs/commands/DescribeAccountSettingsCommand.js +2 -2
- package/dist/cjs/commands/DescribeIAMPolicyAssignmentCommand.js +1 -1
- package/dist/cjs/commands/GetDashboardEmbedUrlCommand.js +1 -1
- package/dist/cjs/commands/GetSessionEmbedUrlCommand.js +3 -3
- package/dist/cjs/commands/ListAnalysesCommand.js +1 -1
- package/dist/cjs/commands/ListDashboardVersionsCommand.js +1 -1
- package/dist/cjs/commands/ListDashboardsCommand.js +1 -1
- package/dist/cjs/commands/ListDataSetsCommand.js +1 -1
- package/dist/cjs/commands/ListDataSourcesCommand.js +1 -1
- package/dist/cjs/commands/ListIAMPolicyAssignmentsCommand.js +1 -1
- package/dist/cjs/commands/ListIAMPolicyAssignmentsForUserCommand.js +1 -1
- package/dist/cjs/commands/ListNamespacesCommand.js +1 -1
- package/dist/cjs/commands/ListThemeVersionsCommand.js +1 -1
- package/dist/cjs/commands/ListThemesCommand.js +1 -1
- package/dist/cjs/commands/TagResourceCommand.js +5 -5
- package/dist/cjs/commands/UpdateAccountCustomizationCommand.js +3 -3
- package/dist/cjs/commands/UpdateAccountSettingsCommand.js +1 -1
- package/dist/cjs/commands/UpdateDashboardCommand.js +1 -1
- package/dist/cjs/commands/UpdateIAMPolicyAssignmentCommand.js +1 -1
- package/dist/cjs/models/models_0.js +49 -37
- package/dist/cjs/models/models_0.js.map +1 -1
- package/dist/cjs/models/models_1.js +34 -3
- package/dist/cjs/models/models_1.js.map +1 -1
- package/dist/cjs/package.json +31 -31
- package/dist/cjs/protocols/Aws_restJson1.js +276 -186
- package/dist/cjs/protocols/Aws_restJson1.js.map +1 -1
- package/dist/es/commands/CreateAccountCustomizationCommand.js +4 -4
- package/dist/es/commands/CreateDashboardCommand.js +3 -3
- package/dist/es/commands/CreateIAMPolicyAssignmentCommand.js +2 -2
- package/dist/es/commands/CreateNamespaceCommand.js +4 -4
- package/dist/es/commands/CreateTemplateCommand.js +1 -1
- package/dist/es/commands/DeleteAccountCustomizationCommand.js +1 -1
- package/dist/es/commands/DeleteAnalysisCommand.js +3 -3
- package/dist/es/commands/DeleteIAMPolicyAssignmentCommand.js +1 -1
- package/dist/es/commands/DescribeAccountCustomizationCommand.js +12 -12
- package/dist/es/commands/DescribeAccountSettingsCommand.js +2 -2
- package/dist/es/commands/DescribeIAMPolicyAssignmentCommand.js +1 -1
- package/dist/es/commands/GetDashboardEmbedUrlCommand.js +1 -1
- package/dist/es/commands/GetSessionEmbedUrlCommand.js +3 -3
- package/dist/es/commands/ListAnalysesCommand.js +1 -1
- package/dist/es/commands/ListDashboardVersionsCommand.js +1 -1
- package/dist/es/commands/ListDashboardsCommand.js +1 -1
- package/dist/es/commands/ListDataSetsCommand.js +1 -1
- package/dist/es/commands/ListDataSourcesCommand.js +1 -1
- package/dist/es/commands/ListIAMPolicyAssignmentsCommand.js +1 -1
- package/dist/es/commands/ListIAMPolicyAssignmentsForUserCommand.js +1 -1
- package/dist/es/commands/ListNamespacesCommand.js +1 -1
- package/dist/es/commands/ListThemeVersionsCommand.js +1 -1
- package/dist/es/commands/ListThemesCommand.js +1 -1
- package/dist/es/commands/TagResourceCommand.js +5 -5
- package/dist/es/commands/UpdateAccountCustomizationCommand.js +3 -3
- package/dist/es/commands/UpdateAccountSettingsCommand.js +1 -1
- package/dist/es/commands/UpdateDashboardCommand.js +1 -1
- package/dist/es/commands/UpdateIAMPolicyAssignmentCommand.js +1 -1
- package/dist/es/endpoints.js +1 -2
- package/dist/es/endpoints.js.map +1 -1
- package/dist/es/models/models_0.js +37 -25
- package/dist/es/models/models_0.js.map +1 -1
- package/dist/es/models/models_1.js +25 -0
- package/dist/es/models/models_1.js.map +1 -1
- package/dist/es/package.json +31 -31
- package/dist/es/protocols/Aws_restJson1.js +835 -530
- package/dist/es/protocols/Aws_restJson1.js.map +1 -1
- package/dist/types/QuickSight.d.ts +59 -59
- package/dist/types/commands/CreateAccountCustomizationCommand.d.ts +4 -4
- package/dist/types/commands/CreateDashboardCommand.d.ts +3 -3
- package/dist/types/commands/CreateIAMPolicyAssignmentCommand.d.ts +2 -2
- package/dist/types/commands/CreateNamespaceCommand.d.ts +4 -4
- package/dist/types/commands/CreateTemplateCommand.d.ts +1 -1
- package/dist/types/commands/DeleteAccountCustomizationCommand.d.ts +1 -1
- package/dist/types/commands/DeleteAnalysisCommand.d.ts +3 -3
- package/dist/types/commands/DeleteIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist/types/commands/DescribeAccountCustomizationCommand.d.ts +12 -12
- package/dist/types/commands/DescribeAccountSettingsCommand.d.ts +2 -2
- package/dist/types/commands/DescribeIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist/types/commands/GetDashboardEmbedUrlCommand.d.ts +1 -1
- package/dist/types/commands/GetSessionEmbedUrlCommand.d.ts +3 -3
- package/dist/types/commands/ListAnalysesCommand.d.ts +1 -1
- package/dist/types/commands/ListDashboardVersionsCommand.d.ts +1 -1
- package/dist/types/commands/ListDashboardsCommand.d.ts +1 -1
- package/dist/types/commands/ListDataSetsCommand.d.ts +1 -1
- package/dist/types/commands/ListDataSourcesCommand.d.ts +1 -1
- package/dist/types/commands/ListIAMPolicyAssignmentsCommand.d.ts +1 -1
- package/dist/types/commands/ListIAMPolicyAssignmentsForUserCommand.d.ts +1 -1
- package/dist/types/commands/ListNamespacesCommand.d.ts +1 -1
- package/dist/types/commands/ListThemeVersionsCommand.d.ts +1 -1
- package/dist/types/commands/ListThemesCommand.d.ts +1 -1
- package/dist/types/commands/TagResourceCommand.d.ts +5 -5
- package/dist/types/commands/UpdateAccountCustomizationCommand.d.ts +3 -3
- package/dist/types/commands/UpdateAccountSettingsCommand.d.ts +1 -1
- package/dist/types/commands/UpdateDashboardCommand.d.ts +1 -1
- package/dist/types/commands/UpdateIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist/types/models/models_0.d.ts +340 -293
- package/dist/types/models/models_1.d.ts +214 -129
- package/dist/types/ts3.4/QuickSight.d.ts +59 -59
- package/dist/types/ts3.4/commands/CreateAccountCustomizationCommand.d.ts +4 -4
- package/dist/types/ts3.4/commands/CreateDashboardCommand.d.ts +3 -3
- package/dist/types/ts3.4/commands/CreateIAMPolicyAssignmentCommand.d.ts +2 -2
- package/dist/types/ts3.4/commands/CreateNamespaceCommand.d.ts +4 -4
- package/dist/types/ts3.4/commands/CreateTemplateCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/DeleteAccountCustomizationCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/DeleteAnalysisCommand.d.ts +3 -3
- package/dist/types/ts3.4/commands/DeleteIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/DescribeAccountCustomizationCommand.d.ts +12 -12
- package/dist/types/ts3.4/commands/DescribeAccountSettingsCommand.d.ts +2 -2
- package/dist/types/ts3.4/commands/DescribeIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/GetDashboardEmbedUrlCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/GetSessionEmbedUrlCommand.d.ts +3 -3
- package/dist/types/ts3.4/commands/ListAnalysesCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/ListDashboardVersionsCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/ListDashboardsCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/ListDataSetsCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/ListDataSourcesCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/ListIAMPolicyAssignmentsCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/ListIAMPolicyAssignmentsForUserCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/ListNamespacesCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/ListThemeVersionsCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/ListThemesCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/TagResourceCommand.d.ts +5 -5
- package/dist/types/ts3.4/commands/UpdateAccountCustomizationCommand.d.ts +3 -3
- package/dist/types/ts3.4/commands/UpdateAccountSettingsCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/UpdateDashboardCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/UpdateIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist/types/ts3.4/models/models_0.d.ts +340 -293
- package/dist/types/ts3.4/models/models_1.d.ts +214 -129
- package/models/models_0.ts +369 -312
- package/models/models_1.ts +238 -131
- package/package.json +31 -31
- package/protocols/Aws_restJson1.ts +321 -190
|
@@ -1,5 +1,85 @@
|
|
|
1
|
-
import { AccountCustomization, ActiveIAMPolicyAssignment, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, AssignmentStatus, ColumnGroup, ColumnLevelPermissionRule, DashboardPublishOptions, DashboardSearchFilter, DashboardSourceEntity, DashboardSummary, DashboardVersionSummary, DataSetImportMode, DataSetSummary, DataSource, DataSourceCredentials, DataSourceParameters, EmbeddingIdentityType, FieldFolder,
|
|
1
|
+
import { AccountCustomization, ActiveIAMPolicyAssignment, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, AssignmentStatus, ColumnGroup, ColumnLevelPermissionRule, DashboardPublishOptions, DashboardSearchFilter, DashboardSourceEntity, DashboardSummary, DashboardVersionSummary, DataSetImportMode, DataSetSummary, DataSetUsageConfiguration, DataSource, DataSourceCredentials, DataSourceParameters, EmbeddingIdentityType, FieldFolder, FilterOperator, FolderType, Group, GroupMember, IdentityType, Ingestion, LogicalTable, NamespaceInfoV2, PhysicalTable, ResourcePermission, ResourceStatus, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SslProperties, Tag, TemplateAlias, TemplateSourceEntity, ThemeAlias, ThemeConfiguration, ThemeType, User, UserRole, VpcConnectionProperties, _Parameters } from "./models_0";
|
|
2
2
|
import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
|
|
3
|
+
export declare enum FolderFilterAttribute {
|
|
4
|
+
PARENT_FOLDER_ARN = "PARENT_FOLDER_ARN"
|
|
5
|
+
}
|
|
6
|
+
/**
|
|
7
|
+
* <p>An object that consists of the member Amazon Resource Name (ARN) and member ID.</p>
|
|
8
|
+
*/
|
|
9
|
+
export interface MemberIdArnPair {
|
|
10
|
+
/**
|
|
11
|
+
* <p>The ID of the member.</p>
|
|
12
|
+
*/
|
|
13
|
+
MemberId?: string;
|
|
14
|
+
/**
|
|
15
|
+
* <p>The Amazon Resource Name (ARN) of the member.</p>
|
|
16
|
+
*/
|
|
17
|
+
MemberArn?: string;
|
|
18
|
+
}
|
|
19
|
+
export declare namespace MemberIdArnPair {
|
|
20
|
+
/**
|
|
21
|
+
* @internal
|
|
22
|
+
*/
|
|
23
|
+
const filterSensitiveLog: (obj: MemberIdArnPair) => any;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* <p>Searches a folder by a filter.</p>
|
|
27
|
+
*/
|
|
28
|
+
export interface FolderSearchFilter {
|
|
29
|
+
/**
|
|
30
|
+
* <p>The comparison operator that you want to use as a filter. For example, <code>"Operator": "StringEquals"</code>.</p>
|
|
31
|
+
*/
|
|
32
|
+
Operator?: FilterOperator | string;
|
|
33
|
+
/**
|
|
34
|
+
* <p>The name of the value that you want to use as a filter. For example, <code>"Name": "PARENT_FOLDER_ARN"</code>.</p>
|
|
35
|
+
*/
|
|
36
|
+
Name?: FolderFilterAttribute | string;
|
|
37
|
+
/**
|
|
38
|
+
* <p>The value of the named item (in this example, <code>PARENT_FOLDER_ARN</code>), that you want to use as a filter. For example, <code>"Value": "arn:aws:quicksight:us-east-1:1:folder/folderId"</code>.</p>
|
|
39
|
+
*/
|
|
40
|
+
Value?: string;
|
|
41
|
+
}
|
|
42
|
+
export declare namespace FolderSearchFilter {
|
|
43
|
+
/**
|
|
44
|
+
* @internal
|
|
45
|
+
*/
|
|
46
|
+
const filterSensitiveLog: (obj: FolderSearchFilter) => any;
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* <p>A summary of the folder. </p>
|
|
50
|
+
*/
|
|
51
|
+
export interface FolderSummary {
|
|
52
|
+
/**
|
|
53
|
+
* <p>The Amazon Resource Name (ARN).</p>
|
|
54
|
+
*/
|
|
55
|
+
Arn?: string;
|
|
56
|
+
/**
|
|
57
|
+
* <p>The folder ID.</p>
|
|
58
|
+
*/
|
|
59
|
+
FolderId?: string;
|
|
60
|
+
/**
|
|
61
|
+
* <p>The display name of the folder.</p>
|
|
62
|
+
*/
|
|
63
|
+
Name?: string;
|
|
64
|
+
/**
|
|
65
|
+
* <p>The type of folder.</p>
|
|
66
|
+
*/
|
|
67
|
+
FolderType?: FolderType | string;
|
|
68
|
+
/**
|
|
69
|
+
* <p>The time that the folder was created.</p>
|
|
70
|
+
*/
|
|
71
|
+
CreatedTime?: Date;
|
|
72
|
+
/**
|
|
73
|
+
* <p>The time that the folder was last updated.</p>
|
|
74
|
+
*/
|
|
75
|
+
LastUpdatedTime?: Date;
|
|
76
|
+
}
|
|
77
|
+
export declare namespace FolderSummary {
|
|
78
|
+
/**
|
|
79
|
+
* @internal
|
|
80
|
+
*/
|
|
81
|
+
const filterSensitiveLog: (obj: FolderSummary) => any;
|
|
82
|
+
}
|
|
3
83
|
/**
|
|
4
84
|
* <p>The key-value pair used for the row-level security tags feature.</p>
|
|
5
85
|
*/
|
|
@@ -94,9 +174,9 @@ export declare namespace SessionLifetimeInMinutesInvalidException {
|
|
|
94
174
|
}
|
|
95
175
|
/**
|
|
96
176
|
* <p>This error indicates that you are calling an embedding operation in Amazon QuickSight
|
|
97
|
-
* without the required pricing plan on your Amazon Web Services account
|
|
98
|
-
* for anonymous users, a QuickSight administrator needs to add capacity pricing to QuickSight. You
|
|
99
|
-
* can do this on the <b>Manage QuickSight</b> page. </p>
|
|
177
|
+
* without the required pricing plan on your Amazon Web Services account. Before you can use embedding
|
|
178
|
+
* for anonymous users, a Amazon QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You
|
|
179
|
+
* can do this on the <b>Manage Amazon QuickSight</b> page. </p>
|
|
100
180
|
* <p>After capacity pricing is added, you can use the
|
|
101
181
|
* <a>GetDashboardEmbedUrl</a> API operation with the
|
|
102
182
|
* <code>--identity-type ANONYMOUS</code> option.</p>
|
|
@@ -292,7 +372,7 @@ export declare namespace QuickSightUserNotFoundException {
|
|
|
292
372
|
}
|
|
293
373
|
export interface GetDashboardEmbedUrlRequest {
|
|
294
374
|
/**
|
|
295
|
-
* <p>The ID for the Amazon Web Services account
|
|
375
|
+
* <p>The ID for the Amazon Web Services account that contains the dashboard that you're embedding.</p>
|
|
296
376
|
*/
|
|
297
377
|
AwsAccountId: string | undefined;
|
|
298
378
|
/**
|
|
@@ -321,9 +401,9 @@ export interface GetDashboardEmbedUrlRequest {
|
|
|
321
401
|
/**
|
|
322
402
|
* <p>Adds persistence of state for the user session in an embedded dashboard. Persistence
|
|
323
403
|
* applies to the sheet and the parameter settings. These are control settings that the
|
|
324
|
-
* dashboard subscriber (QuickSight reader) chooses while viewing the dashboard. If this is
|
|
404
|
+
* dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is
|
|
325
405
|
* set to <code>TRUE</code>, the settings are the same when the subscriber reopens the same
|
|
326
|
-
* dashboard URL. The state is stored in QuickSight, not in a browser cookie. If this is
|
|
406
|
+
* dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is
|
|
327
407
|
* set to FALSE, the state of the user session is not persisted. The default is
|
|
328
408
|
* <code>FALSE</code>.</p>
|
|
329
409
|
*/
|
|
@@ -340,23 +420,24 @@ export interface GetDashboardEmbedUrlRequest {
|
|
|
340
420
|
* <p>Invited nonfederated users</p>
|
|
341
421
|
* </li>
|
|
342
422
|
* <li>
|
|
343
|
-
* <p>
|
|
344
|
-
* SAML, OpenID Connect, or
|
|
423
|
+
* <p>IAMusers and IAMrole-based sessions authenticated through Federated Single Sign-On using
|
|
424
|
+
* SAML, OpenID Connect, or IAMfederation.</p>
|
|
345
425
|
* </li>
|
|
346
426
|
* </ul>
|
|
347
|
-
* <p>Omit this parameter for users in the third group –
|
|
427
|
+
* <p>Omit this parameter for users in the third group – IAMusers and IAM
|
|
348
428
|
* role-based sessions.</p>
|
|
349
429
|
*/
|
|
350
430
|
UserArn?: string;
|
|
351
431
|
/**
|
|
352
|
-
* <p>The Amazon QuickSight namespace that the
|
|
432
|
+
* <p>The Amazon QuickSight namespace that contains the dashboard IDs in this request.
|
|
433
|
+
* If you're not using a custom namespace, set <code>Namespace = default</code>.</p>
|
|
353
434
|
*/
|
|
354
435
|
Namespace?: string;
|
|
355
436
|
/**
|
|
356
437
|
* <p>A list of one or more dashboard IDs that you want to add to a session that includes
|
|
357
438
|
* anonymous users. The <code>IdentityType</code> parameter must be set to
|
|
358
439
|
* <code>ANONYMOUS</code> for this to work, because other identity types authenticate
|
|
359
|
-
* as QuickSight or
|
|
440
|
+
* as Amazon QuickSight or IAMusers. For example, if you set "<code>--dashboard-id dash_id1
|
|
360
441
|
* --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS</code>", the session
|
|
361
442
|
* can access all three dashboards. </p>
|
|
362
443
|
*/
|
|
@@ -415,7 +496,7 @@ export declare namespace IdentityTypeNotSupportedException {
|
|
|
415
496
|
}
|
|
416
497
|
export interface GetSessionEmbedUrlRequest {
|
|
417
498
|
/**
|
|
418
|
-
* <p>The ID for the Amazon Web Services account
|
|
499
|
+
* <p>The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.</p>
|
|
419
500
|
*/
|
|
420
501
|
AwsAccountId: string | undefined;
|
|
421
502
|
/**
|
|
@@ -445,12 +526,12 @@ export interface GetSessionEmbedUrlRequest {
|
|
|
445
526
|
* <li>
|
|
446
527
|
* <p>
|
|
447
528
|
* <code>/dashboards/<i>DashboardId</i>
|
|
448
|
-
* </code> - where <code>DashboardId</code> is the actual ID key from the QuickSight console URL of the dashboard</p>
|
|
529
|
+
* </code> - where <code>DashboardId</code> is the actual ID key from the Amazon QuickSight console URL of the dashboard</p>
|
|
449
530
|
* </li>
|
|
450
531
|
* <li>
|
|
451
532
|
* <p>
|
|
452
533
|
* <code>/analyses/<i>AnalysisId</i>
|
|
453
|
-
* </code> - where <code>AnalysisId</code> is the actual ID key from the QuickSight console URL of the analysis</p>
|
|
534
|
+
* </code> - where <code>AnalysisId</code> is the actual ID key from the Amazon QuickSight console URL of the analysis</p>
|
|
454
535
|
* </li>
|
|
455
536
|
* </ul>
|
|
456
537
|
*/
|
|
@@ -490,7 +571,7 @@ export declare namespace GetSessionEmbedUrlRequest {
|
|
|
490
571
|
export interface GetSessionEmbedUrlResponse {
|
|
491
572
|
/**
|
|
492
573
|
* <p>A single-use URL that you can put into your server-side web page to embed your
|
|
493
|
-
* QuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an
|
|
574
|
+
* Amazon QuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an
|
|
494
575
|
* <code>auth_code</code> value that enables one (and only one) sign-on to a user session
|
|
495
576
|
* that is valid for 10 hours. </p>
|
|
496
577
|
*/
|
|
@@ -511,7 +592,7 @@ export declare namespace GetSessionEmbedUrlResponse {
|
|
|
511
592
|
const filterSensitiveLog: (obj: GetSessionEmbedUrlResponse) => any;
|
|
512
593
|
}
|
|
513
594
|
/**
|
|
514
|
-
* <p>
|
|
595
|
+
* <p>IAMpolicy assignment summary.</p>
|
|
515
596
|
*/
|
|
516
597
|
export interface IAMPolicyAssignmentSummary {
|
|
517
598
|
/**
|
|
@@ -531,7 +612,7 @@ export declare namespace IAMPolicyAssignmentSummary {
|
|
|
531
612
|
}
|
|
532
613
|
export interface ListAnalysesRequest {
|
|
533
614
|
/**
|
|
534
|
-
* <p>The ID of the Amazon Web Services account
|
|
615
|
+
* <p>The ID of the Amazon Web Services account that contains the analyses.</p>
|
|
535
616
|
*/
|
|
536
617
|
AwsAccountId: string | undefined;
|
|
537
618
|
/**
|
|
@@ -575,7 +656,7 @@ export declare namespace ListAnalysesResponse {
|
|
|
575
656
|
}
|
|
576
657
|
export interface ListDashboardsRequest {
|
|
577
658
|
/**
|
|
578
|
-
* <p>The ID of the Amazon Web Services account
|
|
659
|
+
* <p>The ID of the Amazon Web Services account that contains the dashboards that you're
|
|
579
660
|
* listing.</p>
|
|
580
661
|
*/
|
|
581
662
|
AwsAccountId: string | undefined;
|
|
@@ -596,7 +677,7 @@ export declare namespace ListDashboardsRequest {
|
|
|
596
677
|
}
|
|
597
678
|
export interface ListDashboardsResponse {
|
|
598
679
|
/**
|
|
599
|
-
* <p>A structure that contains all of the dashboards in your Amazon Web Services account
|
|
680
|
+
* <p>A structure that contains all of the dashboards in your Amazon Web Services account. This structure
|
|
600
681
|
* provides basic information about the dashboards.</p>
|
|
601
682
|
*/
|
|
602
683
|
DashboardSummaryList?: DashboardSummary[];
|
|
@@ -621,7 +702,7 @@ export declare namespace ListDashboardsResponse {
|
|
|
621
702
|
}
|
|
622
703
|
export interface ListDashboardVersionsRequest {
|
|
623
704
|
/**
|
|
624
|
-
* <p>The ID of the Amazon Web Services account
|
|
705
|
+
* <p>The ID of the Amazon Web Services account that contains the dashboard that you're listing versions
|
|
625
706
|
* for.</p>
|
|
626
707
|
*/
|
|
627
708
|
AwsAccountId: string | undefined;
|
|
@@ -670,7 +751,7 @@ export declare namespace ListDashboardVersionsResponse {
|
|
|
670
751
|
}
|
|
671
752
|
export interface ListDataSetsRequest {
|
|
672
753
|
/**
|
|
673
|
-
* <p>The Amazon Web Services account
|
|
754
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
674
755
|
*/
|
|
675
756
|
AwsAccountId: string | undefined;
|
|
676
757
|
/**
|
|
@@ -714,7 +795,7 @@ export declare namespace ListDataSetsResponse {
|
|
|
714
795
|
}
|
|
715
796
|
export interface ListDataSourcesRequest {
|
|
716
797
|
/**
|
|
717
|
-
* <p>The Amazon Web Services account
|
|
798
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
718
799
|
*/
|
|
719
800
|
AwsAccountId: string | undefined;
|
|
720
801
|
/**
|
|
@@ -864,8 +945,8 @@ export interface ListGroupMembershipsRequest {
|
|
|
864
945
|
*/
|
|
865
946
|
MaxResults?: number;
|
|
866
947
|
/**
|
|
867
|
-
* <p>The ID for the Amazon Web Services account
|
|
868
|
-
* Amazon Web Services account
|
|
948
|
+
* <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
|
|
949
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
869
950
|
*/
|
|
870
951
|
AwsAccountId: string | undefined;
|
|
871
952
|
/**
|
|
@@ -905,8 +986,8 @@ export declare namespace ListGroupMembershipsResponse {
|
|
|
905
986
|
}
|
|
906
987
|
export interface ListGroupsRequest {
|
|
907
988
|
/**
|
|
908
|
-
* <p>The ID for the Amazon Web Services account
|
|
909
|
-
* Amazon Web Services account
|
|
989
|
+
* <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
|
|
990
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
910
991
|
*/
|
|
911
992
|
AwsAccountId: string | undefined;
|
|
912
993
|
/**
|
|
@@ -954,7 +1035,7 @@ export declare namespace ListGroupsResponse {
|
|
|
954
1035
|
}
|
|
955
1036
|
export interface ListIAMPolicyAssignmentsRequest {
|
|
956
1037
|
/**
|
|
957
|
-
* <p>The ID of the Amazon Web Services account
|
|
1038
|
+
* <p>The ID of the Amazon Web Services account that contains these IAMpolicy assignments.</p>
|
|
958
1039
|
*/
|
|
959
1040
|
AwsAccountId: string | undefined;
|
|
960
1041
|
/**
|
|
@@ -982,7 +1063,7 @@ export declare namespace ListIAMPolicyAssignmentsRequest {
|
|
|
982
1063
|
}
|
|
983
1064
|
export interface ListIAMPolicyAssignmentsResponse {
|
|
984
1065
|
/**
|
|
985
|
-
* <p>Information describing the
|
|
1066
|
+
* <p>Information describing the IAMpolicy assignments.</p>
|
|
986
1067
|
*/
|
|
987
1068
|
IAMPolicyAssignments?: IAMPolicyAssignmentSummary[];
|
|
988
1069
|
/**
|
|
@@ -1006,7 +1087,7 @@ export declare namespace ListIAMPolicyAssignmentsResponse {
|
|
|
1006
1087
|
}
|
|
1007
1088
|
export interface ListIAMPolicyAssignmentsForUserRequest {
|
|
1008
1089
|
/**
|
|
1009
|
-
* <p>The ID of the Amazon Web Services account
|
|
1090
|
+
* <p>The ID of the Amazon Web Services account that contains the assignments.</p>
|
|
1010
1091
|
*/
|
|
1011
1092
|
AwsAccountId: string | undefined;
|
|
1012
1093
|
/**
|
|
@@ -1066,7 +1147,7 @@ export interface ListIngestionsRequest {
|
|
|
1066
1147
|
*/
|
|
1067
1148
|
NextToken?: string;
|
|
1068
1149
|
/**
|
|
1069
|
-
* <p>The Amazon Web Services account
|
|
1150
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
1070
1151
|
*/
|
|
1071
1152
|
AwsAccountId: string | undefined;
|
|
1072
1153
|
/**
|
|
@@ -1106,7 +1187,7 @@ export declare namespace ListIngestionsResponse {
|
|
|
1106
1187
|
}
|
|
1107
1188
|
export interface ListNamespacesRequest {
|
|
1108
1189
|
/**
|
|
1109
|
-
* <p>The ID for the Amazon Web Services account
|
|
1190
|
+
* <p>The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.</p>
|
|
1110
1191
|
*/
|
|
1111
1192
|
AwsAccountId: string | undefined;
|
|
1112
1193
|
/**
|
|
@@ -1126,7 +1207,7 @@ export declare namespace ListNamespacesRequest {
|
|
|
1126
1207
|
}
|
|
1127
1208
|
export interface ListNamespacesResponse {
|
|
1128
1209
|
/**
|
|
1129
|
-
* <p>The information about the namespaces in this Amazon Web Services account
|
|
1210
|
+
* <p>The information about the namespaces in this Amazon Web Services account. The response includes
|
|
1130
1211
|
* the namespace ARN, name, Amazon Web Services Region;, notification email address, creation status, and
|
|
1131
1212
|
* identity store.</p>
|
|
1132
1213
|
*/
|
|
@@ -1185,7 +1266,7 @@ export declare namespace ListTagsForResourceResponse {
|
|
|
1185
1266
|
}
|
|
1186
1267
|
export interface ListTemplateAliasesRequest {
|
|
1187
1268
|
/**
|
|
1188
|
-
* <p>The ID of the Amazon Web Services account
|
|
1269
|
+
* <p>The ID of the Amazon Web Services account that contains the template aliases that you're listing.</p>
|
|
1189
1270
|
*/
|
|
1190
1271
|
AwsAccountId: string | undefined;
|
|
1191
1272
|
/**
|
|
@@ -1233,7 +1314,7 @@ export declare namespace ListTemplateAliasesResponse {
|
|
|
1233
1314
|
}
|
|
1234
1315
|
export interface ListTemplatesRequest {
|
|
1235
1316
|
/**
|
|
1236
|
-
* <p>The ID of the Amazon Web Services account
|
|
1317
|
+
* <p>The ID of the Amazon Web Services account that contains the templates that you're listing.</p>
|
|
1237
1318
|
*/
|
|
1238
1319
|
AwsAccountId: string | undefined;
|
|
1239
1320
|
/**
|
|
@@ -1260,7 +1341,7 @@ export interface TemplateSummary {
|
|
|
1260
1341
|
*/
|
|
1261
1342
|
Arn?: string;
|
|
1262
1343
|
/**
|
|
1263
|
-
* <p>The ID of the template. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
1344
|
+
* <p>The ID of the template. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.</p>
|
|
1264
1345
|
*/
|
|
1265
1346
|
TemplateId?: string;
|
|
1266
1347
|
/**
|
|
@@ -1312,7 +1393,7 @@ export declare namespace ListTemplatesResponse {
|
|
|
1312
1393
|
}
|
|
1313
1394
|
export interface ListTemplateVersionsRequest {
|
|
1314
1395
|
/**
|
|
1315
|
-
* <p>The ID of the Amazon Web Services account
|
|
1396
|
+
* <p>The ID of the Amazon Web Services account that contains the templates that you're listing.</p>
|
|
1316
1397
|
*/
|
|
1317
1398
|
AwsAccountId: string | undefined;
|
|
1318
1399
|
/**
|
|
@@ -1391,7 +1472,7 @@ export declare namespace ListTemplateVersionsResponse {
|
|
|
1391
1472
|
}
|
|
1392
1473
|
export interface ListThemeAliasesRequest {
|
|
1393
1474
|
/**
|
|
1394
|
-
* <p>The ID of the Amazon Web Services account
|
|
1475
|
+
* <p>The ID of the Amazon Web Services account that contains the theme aliases that you're listing.</p>
|
|
1395
1476
|
*/
|
|
1396
1477
|
AwsAccountId: string | undefined;
|
|
1397
1478
|
/**
|
|
@@ -1439,7 +1520,7 @@ export declare namespace ListThemeAliasesResponse {
|
|
|
1439
1520
|
}
|
|
1440
1521
|
export interface ListThemesRequest {
|
|
1441
1522
|
/**
|
|
1442
|
-
* <p>The ID of the Amazon Web Services account
|
|
1523
|
+
* <p>The ID of the Amazon Web Services account that contains the themes that you're listing.</p>
|
|
1443
1524
|
*/
|
|
1444
1525
|
AwsAccountId: string | undefined;
|
|
1445
1526
|
/**
|
|
@@ -1488,7 +1569,7 @@ export interface ThemeSummary {
|
|
|
1488
1569
|
*/
|
|
1489
1570
|
Name?: string;
|
|
1490
1571
|
/**
|
|
1491
|
-
* <p>The ID of the theme. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
1572
|
+
* <p>The ID of the theme. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.</p>
|
|
1492
1573
|
*/
|
|
1493
1574
|
ThemeId?: string;
|
|
1494
1575
|
/**
|
|
@@ -1536,7 +1617,7 @@ export declare namespace ListThemesResponse {
|
|
|
1536
1617
|
}
|
|
1537
1618
|
export interface ListThemeVersionsRequest {
|
|
1538
1619
|
/**
|
|
1539
|
-
* <p>The ID of the Amazon Web Services account
|
|
1620
|
+
* <p>The ID of the Amazon Web Services account that contains the themes that you're listing.</p>
|
|
1540
1621
|
*/
|
|
1541
1622
|
AwsAccountId: string | undefined;
|
|
1542
1623
|
/**
|
|
@@ -1619,7 +1700,7 @@ export interface ListUserGroupsRequest {
|
|
|
1619
1700
|
*/
|
|
1620
1701
|
UserName: string | undefined;
|
|
1621
1702
|
/**
|
|
1622
|
-
* <p>The Amazon Web Services account
|
|
1703
|
+
* <p>The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account
|
|
1623
1704
|
* that contains your Amazon QuickSight account.</p>
|
|
1624
1705
|
*/
|
|
1625
1706
|
AwsAccountId: string | undefined;
|
|
@@ -1668,8 +1749,8 @@ export declare namespace ListUserGroupsResponse {
|
|
|
1668
1749
|
}
|
|
1669
1750
|
export interface ListUsersRequest {
|
|
1670
1751
|
/**
|
|
1671
|
-
* <p>The ID for the Amazon Web Services account
|
|
1672
|
-
* Amazon Web Services account
|
|
1752
|
+
* <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the
|
|
1753
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
1673
1754
|
*/
|
|
1674
1755
|
AwsAccountId: string | undefined;
|
|
1675
1756
|
/**
|
|
@@ -1722,7 +1803,7 @@ export interface RegisterUserRequest {
|
|
|
1722
1803
|
* <ul>
|
|
1723
1804
|
* <li>
|
|
1724
1805
|
* <p>
|
|
1725
|
-
* <code>IAM</code>: A user whose identity maps to an existing
|
|
1806
|
+
* <code>IAM</code>: A user whose identity maps to an existing IAMuser or role.
|
|
1726
1807
|
* </p>
|
|
1727
1808
|
* </li>
|
|
1728
1809
|
* <li>
|
|
@@ -1769,23 +1850,23 @@ export interface RegisterUserRequest {
|
|
|
1769
1850
|
*/
|
|
1770
1851
|
UserRole: UserRole | string | undefined;
|
|
1771
1852
|
/**
|
|
1772
|
-
* <p>The ARN of the
|
|
1853
|
+
* <p>The ARN of the IAMuser or role that you are registering with Amazon QuickSight. </p>
|
|
1773
1854
|
*/
|
|
1774
1855
|
IamArn?: string;
|
|
1775
1856
|
/**
|
|
1776
1857
|
* <p>You need to use this parameter only when you register one or more users using an assumed
|
|
1777
|
-
*
|
|
1778
|
-
* you are registering an
|
|
1779
|
-
* users using the same
|
|
1780
|
-
* information on assuming
|
|
1858
|
+
* IAMrole. You don't need to provide the session name for other scenarios, for example when
|
|
1859
|
+
* you are registering an IAMuser or an Amazon QuickSight user. You can register multiple
|
|
1860
|
+
* users using the same IAMrole if each user has a different session name. For more
|
|
1861
|
+
* information on assuming IAMroles, see <a href="https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html">
|
|
1781
1862
|
* <code>assume-role</code>
|
|
1782
1863
|
* </a> in the <i>AWS CLI Reference.</i>
|
|
1783
1864
|
* </p>
|
|
1784
1865
|
*/
|
|
1785
1866
|
SessionName?: string;
|
|
1786
1867
|
/**
|
|
1787
|
-
* <p>The ID for the Amazon Web Services account
|
|
1788
|
-
* Amazon Web Services account
|
|
1868
|
+
* <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the
|
|
1869
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
1789
1870
|
*/
|
|
1790
1871
|
AwsAccountId: string | undefined;
|
|
1791
1872
|
/**
|
|
@@ -1819,17 +1900,17 @@ export interface RegisterUserRequest {
|
|
|
1819
1900
|
* <a>UpdateUser</a>
|
|
1820
1901
|
* </code> instead.</p>
|
|
1821
1902
|
* <p>A set of custom permissions includes any combination of these restrictions. Currently,
|
|
1822
|
-
* you need to create the profile names for custom permission sets by using the QuickSight
|
|
1903
|
+
* you need to create the profile names for custom permission sets by using the Amazon QuickSight
|
|
1823
1904
|
* console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of
|
|
1824
|
-
* permissions to a QuickSight user. </p>
|
|
1825
|
-
* <p>QuickSight custom permissions are applied through
|
|
1826
|
-
* override the permissions typically granted by assigning QuickSight users to one of the
|
|
1827
|
-
* default security cohorts in QuickSight (admin, author, reader).</p>
|
|
1828
|
-
* <p>This feature is available only to QuickSight Enterprise edition subscriptions.</p>
|
|
1905
|
+
* permissions to a Amazon QuickSight user. </p>
|
|
1906
|
+
* <p>Amazon QuickSight custom permissions are applied through IAMpolicies. Therefore, they
|
|
1907
|
+
* override the permissions typically granted by assigning Amazon QuickSight users to one of the
|
|
1908
|
+
* default security cohorts in Amazon QuickSight (admin, author, reader).</p>
|
|
1909
|
+
* <p>This feature is available only to Amazon QuickSight Enterprise edition subscriptions.</p>
|
|
1829
1910
|
*/
|
|
1830
1911
|
CustomPermissionsName?: string;
|
|
1831
1912
|
/**
|
|
1832
|
-
* <p>The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated
|
|
1913
|
+
* <p>The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.</p>
|
|
1833
1914
|
* <ul>
|
|
1834
1915
|
* <li>
|
|
1835
1916
|
* <p>
|
|
@@ -1844,7 +1925,7 @@ export interface RegisterUserRequest {
|
|
|
1844
1925
|
ExternalLoginFederationProviderType?: string;
|
|
1845
1926
|
/**
|
|
1846
1927
|
* <p>The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate
|
|
1847
|
-
* into QuickSight with an associated
|
|
1928
|
+
* into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should
|
|
1848
1929
|
* only be used when <code>ExternalLoginFederationProviderType</code> parameter is set to <code>CUSTOM_OIDC</code>.</p>
|
|
1849
1930
|
*/
|
|
1850
1931
|
CustomFederationProviderUrl?: string;
|
|
@@ -1886,7 +1967,7 @@ export declare namespace RegisterUserResponse {
|
|
|
1886
1967
|
}
|
|
1887
1968
|
export interface RestoreAnalysisRequest {
|
|
1888
1969
|
/**
|
|
1889
|
-
* <p>The ID of the Amazon Web Services account
|
|
1970
|
+
* <p>The ID of the Amazon Web Services account that contains the analysis.</p>
|
|
1890
1971
|
*/
|
|
1891
1972
|
AwsAccountId: string | undefined;
|
|
1892
1973
|
/**
|
|
@@ -1927,7 +2008,7 @@ export declare namespace RestoreAnalysisResponse {
|
|
|
1927
2008
|
}
|
|
1928
2009
|
export interface SearchAnalysesRequest {
|
|
1929
2010
|
/**
|
|
1930
|
-
* <p>The ID of the Amazon Web Services account
|
|
2011
|
+
* <p>The ID of the Amazon Web Services account that contains the analyses that you're searching
|
|
1931
2012
|
* for.</p>
|
|
1932
2013
|
*/
|
|
1933
2014
|
AwsAccountId: string | undefined;
|
|
@@ -1977,7 +2058,7 @@ export declare namespace SearchAnalysesResponse {
|
|
|
1977
2058
|
}
|
|
1978
2059
|
export interface SearchDashboardsRequest {
|
|
1979
2060
|
/**
|
|
1980
|
-
* <p>The ID of the Amazon Web Services account
|
|
2061
|
+
* <p>The ID of the Amazon Web Services account that contains the user whose dashboards you're searching
|
|
1981
2062
|
* for. </p>
|
|
1982
2063
|
*/
|
|
1983
2064
|
AwsAccountId: string | undefined;
|
|
@@ -2142,16 +2223,16 @@ export declare namespace UntagResourceResponse {
|
|
|
2142
2223
|
}
|
|
2143
2224
|
export interface UpdateAccountCustomizationRequest {
|
|
2144
2225
|
/**
|
|
2145
|
-
* <p>The ID for the Amazon Web Services account
|
|
2226
|
+
* <p>The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations
|
|
2146
2227
|
* for.</p>
|
|
2147
2228
|
*/
|
|
2148
2229
|
AwsAccountId: string | undefined;
|
|
2149
2230
|
/**
|
|
2150
|
-
* <p>The namespace that you want to update QuickSight customizations for.</p>
|
|
2231
|
+
* <p>The namespace that you want to update Amazon QuickSight customizations for.</p>
|
|
2151
2232
|
*/
|
|
2152
2233
|
Namespace?: string;
|
|
2153
2234
|
/**
|
|
2154
|
-
* <p>The QuickSight customizations you're updating in the current Amazon Web Services Region;. </p>
|
|
2235
|
+
* <p>The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region;. </p>
|
|
2155
2236
|
*/
|
|
2156
2237
|
AccountCustomization: AccountCustomization | undefined;
|
|
2157
2238
|
}
|
|
@@ -2163,11 +2244,11 @@ export declare namespace UpdateAccountCustomizationRequest {
|
|
|
2163
2244
|
}
|
|
2164
2245
|
export interface UpdateAccountCustomizationResponse {
|
|
2165
2246
|
/**
|
|
2166
|
-
* <p>The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account
|
|
2247
|
+
* <p>The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account.</p>
|
|
2167
2248
|
*/
|
|
2168
2249
|
Arn?: string;
|
|
2169
2250
|
/**
|
|
2170
|
-
* <p>The ID for the Amazon Web Services account
|
|
2251
|
+
* <p>The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations
|
|
2171
2252
|
* for.</p>
|
|
2172
2253
|
*/
|
|
2173
2254
|
AwsAccountId?: string;
|
|
@@ -2176,7 +2257,7 @@ export interface UpdateAccountCustomizationResponse {
|
|
|
2176
2257
|
*/
|
|
2177
2258
|
Namespace?: string;
|
|
2178
2259
|
/**
|
|
2179
|
-
* <p>The QuickSight customizations you're updating in the current Amazon Web Services Region;. </p>
|
|
2260
|
+
* <p>The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region;. </p>
|
|
2180
2261
|
*/
|
|
2181
2262
|
AccountCustomization?: AccountCustomization;
|
|
2182
2263
|
/**
|
|
@@ -2196,20 +2277,20 @@ export declare namespace UpdateAccountCustomizationResponse {
|
|
|
2196
2277
|
}
|
|
2197
2278
|
export interface UpdateAccountSettingsRequest {
|
|
2198
2279
|
/**
|
|
2199
|
-
* <p>The ID for the Amazon Web Services account
|
|
2280
|
+
* <p>The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to
|
|
2200
2281
|
* list.</p>
|
|
2201
2282
|
*/
|
|
2202
2283
|
AwsAccountId: string | undefined;
|
|
2203
2284
|
/**
|
|
2204
|
-
* <p>The default namespace for this Amazon Web Services account
|
|
2285
|
+
* <p>The default namespace for this Amazon Web Services account. Currently, the default is
|
|
2205
2286
|
* <code>default</code>. Identity and Access Management (IAM) users that register
|
|
2206
|
-
* for the first time with QuickSight provide an email that becomes associated with the
|
|
2287
|
+
* for the first time with Amazon QuickSight provide an email that becomes associated with the
|
|
2207
2288
|
* default namespace.</p>
|
|
2208
2289
|
*/
|
|
2209
2290
|
DefaultNamespace: string | undefined;
|
|
2210
2291
|
/**
|
|
2211
|
-
* <p>The email address that you want QuickSight to send notifications to regarding your
|
|
2212
|
-
* Amazon Web Services account
|
|
2292
|
+
* <p>The email address that you want Amazon QuickSight to send notifications to regarding your
|
|
2293
|
+
* Amazon Web Services account or Amazon QuickSight subscription.</p>
|
|
2213
2294
|
*/
|
|
2214
2295
|
NotificationEmail?: string;
|
|
2215
2296
|
}
|
|
@@ -2237,7 +2318,7 @@ export declare namespace UpdateAccountSettingsResponse {
|
|
|
2237
2318
|
}
|
|
2238
2319
|
export interface UpdateAnalysisRequest {
|
|
2239
2320
|
/**
|
|
2240
|
-
* <p>The ID of the Amazon Web Services account
|
|
2321
|
+
* <p>The ID of the Amazon Web Services account that contains the analysis that you're updating.</p>
|
|
2241
2322
|
*/
|
|
2242
2323
|
AwsAccountId: string | undefined;
|
|
2243
2324
|
/**
|
|
@@ -2247,7 +2328,7 @@ export interface UpdateAnalysisRequest {
|
|
|
2247
2328
|
AnalysisId: string | undefined;
|
|
2248
2329
|
/**
|
|
2249
2330
|
* <p>A descriptive name for the analysis that you're updating. This name displays for the
|
|
2250
|
-
* analysis in the QuickSight console.</p>
|
|
2331
|
+
* analysis in the Amazon QuickSight console.</p>
|
|
2251
2332
|
*/
|
|
2252
2333
|
Name: string | undefined;
|
|
2253
2334
|
/**
|
|
@@ -2262,7 +2343,7 @@ export interface UpdateAnalysisRequest {
|
|
|
2262
2343
|
SourceEntity: AnalysisSourceEntity | undefined;
|
|
2263
2344
|
/**
|
|
2264
2345
|
* <p>The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're
|
|
2265
|
-
* creating. To see the theme in the QuickSight console, make sure that you have access to
|
|
2346
|
+
* creating. To see the theme in the Amazon QuickSight console, make sure that you have access to
|
|
2266
2347
|
* it.</p>
|
|
2267
2348
|
*/
|
|
2268
2349
|
ThemeArn?: string;
|
|
@@ -2303,8 +2384,8 @@ export declare namespace UpdateAnalysisResponse {
|
|
|
2303
2384
|
}
|
|
2304
2385
|
export interface UpdateAnalysisPermissionsRequest {
|
|
2305
2386
|
/**
|
|
2306
|
-
* <p>The ID of the Amazon Web Services account
|
|
2307
|
-
* updating. You must be using the Amazon Web Services account
|
|
2387
|
+
* <p>The ID of the Amazon Web Services account that contains the analysis whose permissions you're
|
|
2388
|
+
* updating. You must be using the Amazon Web Services account that the analysis is in.</p>
|
|
2308
2389
|
*/
|
|
2309
2390
|
AwsAccountId: string | undefined;
|
|
2310
2391
|
/**
|
|
@@ -2360,7 +2441,7 @@ export declare namespace UpdateAnalysisPermissionsResponse {
|
|
|
2360
2441
|
}
|
|
2361
2442
|
export interface UpdateDashboardRequest {
|
|
2362
2443
|
/**
|
|
2363
|
-
* <p>The ID of the Amazon Web Services account
|
|
2444
|
+
* <p>The ID of the Amazon Web Services account that contains the dashboard that you're
|
|
2364
2445
|
* updating.</p>
|
|
2365
2446
|
*/
|
|
2366
2447
|
AwsAccountId: string | undefined;
|
|
@@ -2379,8 +2460,8 @@ export interface UpdateDashboardRequest {
|
|
|
2379
2460
|
* entity. If you need to update a dashboard from an analysis, first convert the analysis
|
|
2380
2461
|
* to a template by using the <a>CreateTemplate</a> API operation. For
|
|
2381
2462
|
* <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source
|
|
2382
|
-
* template. The <code>SourceTemplate</code> ARN can contain any Amazon Web Services account
|
|
2383
|
-
* QuickSight-supported Amazon Web Services Region;. </p>
|
|
2463
|
+
* template. The <code>SourceTemplate</code> ARN can contain any Amazon Web Services account and any
|
|
2464
|
+
* Amazon QuickSight-supported Amazon Web Services Region;. </p>
|
|
2384
2465
|
* <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to
|
|
2385
2466
|
* list the replacement datasets for the placeholders listed in the original. The schema in
|
|
2386
2467
|
* each dataset must match its placeholder. </p>
|
|
@@ -2403,7 +2484,7 @@ export interface UpdateDashboardRequest {
|
|
|
2403
2484
|
* <p>
|
|
2404
2485
|
* <code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This
|
|
2405
2486
|
* status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is
|
|
2406
|
-
* set to <code>DISABLED</code>, QuickSight disables the left filter pane on the
|
|
2487
|
+
* set to <code>DISABLED</code>, Amazon QuickSight disables the left filter pane on the
|
|
2407
2488
|
* published dashboard, which can be used for ad hoc (one-time) filtering. This
|
|
2408
2489
|
* option is <code>ENABLED</code> by default. </p>
|
|
2409
2490
|
* </li>
|
|
@@ -2426,7 +2507,7 @@ export interface UpdateDashboardRequest {
|
|
|
2426
2507
|
/**
|
|
2427
2508
|
* <p>The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If
|
|
2428
2509
|
* you add a value for this field, it overrides the value that was originally associated
|
|
2429
|
-
* with the entity. The theme ARN must exist in the same Amazon Web Services account
|
|
2510
|
+
* with the entity. The theme ARN must exist in the same Amazon Web Services account where you create the
|
|
2430
2511
|
* dashboard.</p>
|
|
2431
2512
|
*/
|
|
2432
2513
|
ThemeArn?: string;
|
|
@@ -2471,7 +2552,7 @@ export declare namespace UpdateDashboardResponse {
|
|
|
2471
2552
|
}
|
|
2472
2553
|
export interface UpdateDashboardPermissionsRequest {
|
|
2473
2554
|
/**
|
|
2474
|
-
* <p>The ID of the Amazon Web Services account
|
|
2555
|
+
* <p>The ID of the Amazon Web Services account that contains the dashboard whose permissions you're
|
|
2475
2556
|
* updating.</p>
|
|
2476
2557
|
*/
|
|
2477
2558
|
AwsAccountId: string | undefined;
|
|
@@ -2524,7 +2605,7 @@ export declare namespace UpdateDashboardPermissionsResponse {
|
|
|
2524
2605
|
}
|
|
2525
2606
|
export interface UpdateDashboardPublishedVersionRequest {
|
|
2526
2607
|
/**
|
|
2527
|
-
* <p>The ID of the Amazon Web Services account
|
|
2608
|
+
* <p>The ID of the Amazon Web Services account that contains the dashboard that you're
|
|
2528
2609
|
* updating.</p>
|
|
2529
2610
|
*/
|
|
2530
2611
|
AwsAccountId: string | undefined;
|
|
@@ -2569,12 +2650,12 @@ export declare namespace UpdateDashboardPublishedVersionResponse {
|
|
|
2569
2650
|
}
|
|
2570
2651
|
export interface UpdateDataSetRequest {
|
|
2571
2652
|
/**
|
|
2572
|
-
* <p>The Amazon Web Services account
|
|
2653
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
2573
2654
|
*/
|
|
2574
2655
|
AwsAccountId: string | undefined;
|
|
2575
2656
|
/**
|
|
2576
2657
|
* <p>The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region; for each
|
|
2577
|
-
* Amazon Web Services account
|
|
2658
|
+
* Amazon Web Services account.</p>
|
|
2578
2659
|
*/
|
|
2579
2660
|
DataSetId: string | undefined;
|
|
2580
2661
|
/**
|
|
@@ -2598,7 +2679,7 @@ export interface UpdateDataSetRequest {
|
|
|
2598
2679
|
*/
|
|
2599
2680
|
ImportMode: DataSetImportMode | string | undefined;
|
|
2600
2681
|
/**
|
|
2601
|
-
* <p>Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.</p>
|
|
2682
|
+
* <p>Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.</p>
|
|
2602
2683
|
*/
|
|
2603
2684
|
ColumnGroups?: ColumnGroup[];
|
|
2604
2685
|
/**
|
|
@@ -2621,6 +2702,10 @@ export interface UpdateDataSetRequest {
|
|
|
2621
2702
|
* </code>.</p>
|
|
2622
2703
|
*/
|
|
2623
2704
|
ColumnLevelPermissionRules?: ColumnLevelPermissionRule[];
|
|
2705
|
+
/**
|
|
2706
|
+
* <p>The usage configuration to apply to child datasets that reference this dataset as a source.</p>
|
|
2707
|
+
*/
|
|
2708
|
+
DataSetUsageConfiguration?: DataSetUsageConfiguration;
|
|
2624
2709
|
}
|
|
2625
2710
|
export declare namespace UpdateDataSetRequest {
|
|
2626
2711
|
/**
|
|
@@ -2634,7 +2719,7 @@ export interface UpdateDataSetResponse {
|
|
|
2634
2719
|
*/
|
|
2635
2720
|
Arn?: string;
|
|
2636
2721
|
/**
|
|
2637
|
-
* <p>The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
2722
|
+
* <p>The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.</p>
|
|
2638
2723
|
*/
|
|
2639
2724
|
DataSetId?: string;
|
|
2640
2725
|
/**
|
|
@@ -2664,12 +2749,12 @@ export declare namespace UpdateDataSetResponse {
|
|
|
2664
2749
|
}
|
|
2665
2750
|
export interface UpdateDataSetPermissionsRequest {
|
|
2666
2751
|
/**
|
|
2667
|
-
* <p>The Amazon Web Services account
|
|
2752
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
2668
2753
|
*/
|
|
2669
2754
|
AwsAccountId: string | undefined;
|
|
2670
2755
|
/**
|
|
2671
2756
|
* <p>The ID for the dataset whose permissions you want to update. This ID is unique per
|
|
2672
|
-
* Amazon Web Services Region; for each Amazon Web Services account
|
|
2757
|
+
* Amazon Web Services Region; for each Amazon Web Services account.</p>
|
|
2673
2758
|
*/
|
|
2674
2759
|
DataSetId: string | undefined;
|
|
2675
2760
|
/**
|
|
@@ -2694,7 +2779,7 @@ export interface UpdateDataSetPermissionsResponse {
|
|
|
2694
2779
|
DataSetArn?: string;
|
|
2695
2780
|
/**
|
|
2696
2781
|
* <p>The ID for the dataset whose permissions you want to update. This ID is unique per
|
|
2697
|
-
* Amazon Web Services Region; for each Amazon Web Services account
|
|
2782
|
+
* Amazon Web Services Region; for each Amazon Web Services account.</p>
|
|
2698
2783
|
*/
|
|
2699
2784
|
DataSetId?: string;
|
|
2700
2785
|
/**
|
|
@@ -2714,11 +2799,11 @@ export declare namespace UpdateDataSetPermissionsResponse {
|
|
|
2714
2799
|
}
|
|
2715
2800
|
export interface UpdateDataSourceRequest {
|
|
2716
2801
|
/**
|
|
2717
|
-
* <p>The Amazon Web Services account
|
|
2802
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
2718
2803
|
*/
|
|
2719
2804
|
AwsAccountId: string | undefined;
|
|
2720
2805
|
/**
|
|
2721
|
-
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
2806
|
+
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account. </p>
|
|
2722
2807
|
*/
|
|
2723
2808
|
DataSourceId: string | undefined;
|
|
2724
2809
|
/**
|
|
@@ -2726,21 +2811,21 @@ export interface UpdateDataSourceRequest {
|
|
|
2726
2811
|
*/
|
|
2727
2812
|
Name: string | undefined;
|
|
2728
2813
|
/**
|
|
2729
|
-
* <p>The parameters that QuickSight uses to connect to your underlying source.</p>
|
|
2814
|
+
* <p>The parameters that Amazon QuickSight uses to connect to your underlying source.</p>
|
|
2730
2815
|
*/
|
|
2731
2816
|
DataSourceParameters?: DataSourceParameters;
|
|
2732
2817
|
/**
|
|
2733
|
-
* <p>The credentials that QuickSight that uses to connect to your underlying source. Currently,
|
|
2818
|
+
* <p>The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently,
|
|
2734
2819
|
* only credentials based on user name and password are supported.</p>
|
|
2735
2820
|
*/
|
|
2736
2821
|
Credentials?: DataSourceCredentials;
|
|
2737
2822
|
/**
|
|
2738
|
-
* <p>Use this parameter only when you want QuickSight to use a VPC connection when connecting to
|
|
2823
|
+
* <p>Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to
|
|
2739
2824
|
* your underlying source.</p>
|
|
2740
2825
|
*/
|
|
2741
2826
|
VpcConnectionProperties?: VpcConnectionProperties;
|
|
2742
2827
|
/**
|
|
2743
|
-
* <p>Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying
|
|
2828
|
+
* <p>Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying
|
|
2744
2829
|
* source.</p>
|
|
2745
2830
|
*/
|
|
2746
2831
|
SslProperties?: SslProperties;
|
|
@@ -2757,7 +2842,7 @@ export interface UpdateDataSourceResponse {
|
|
|
2757
2842
|
*/
|
|
2758
2843
|
Arn?: string;
|
|
2759
2844
|
/**
|
|
2760
|
-
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
2845
|
+
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.</p>
|
|
2761
2846
|
*/
|
|
2762
2847
|
DataSourceId?: string;
|
|
2763
2848
|
/**
|
|
@@ -2781,11 +2866,11 @@ export declare namespace UpdateDataSourceResponse {
|
|
|
2781
2866
|
}
|
|
2782
2867
|
export interface UpdateDataSourcePermissionsRequest {
|
|
2783
2868
|
/**
|
|
2784
|
-
* <p>The Amazon Web Services account
|
|
2869
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
2785
2870
|
*/
|
|
2786
2871
|
AwsAccountId: string | undefined;
|
|
2787
2872
|
/**
|
|
2788
|
-
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
2873
|
+
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account. </p>
|
|
2789
2874
|
*/
|
|
2790
2875
|
DataSourceId: string | undefined;
|
|
2791
2876
|
/**
|
|
@@ -2809,7 +2894,7 @@ export interface UpdateDataSourcePermissionsResponse {
|
|
|
2809
2894
|
*/
|
|
2810
2895
|
DataSourceArn?: string;
|
|
2811
2896
|
/**
|
|
2812
|
-
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
2897
|
+
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.</p>
|
|
2813
2898
|
*/
|
|
2814
2899
|
DataSourceId?: string;
|
|
2815
2900
|
/**
|
|
@@ -2933,8 +3018,8 @@ export interface UpdateGroupRequest {
|
|
|
2933
3018
|
*/
|
|
2934
3019
|
Description?: string;
|
|
2935
3020
|
/**
|
|
2936
|
-
* <p>The ID for the Amazon Web Services account
|
|
2937
|
-
* Amazon Web Services account
|
|
3021
|
+
* <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
|
|
3022
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
2938
3023
|
*/
|
|
2939
3024
|
AwsAccountId: string | undefined;
|
|
2940
3025
|
/**
|
|
@@ -2970,11 +3055,11 @@ export declare namespace UpdateGroupResponse {
|
|
|
2970
3055
|
}
|
|
2971
3056
|
export interface UpdateIAMPolicyAssignmentRequest {
|
|
2972
3057
|
/**
|
|
2973
|
-
* <p>The ID of the Amazon Web Services account
|
|
3058
|
+
* <p>The ID of the Amazon Web Services account that contains the IAMpolicy assignment. </p>
|
|
2974
3059
|
*/
|
|
2975
3060
|
AwsAccountId: string | undefined;
|
|
2976
3061
|
/**
|
|
2977
|
-
* <p>The name of the assignment, also called a rule. This name must be unique within an Amazon Web Services account
|
|
3062
|
+
* <p>The name of the assignment, also called a rule. This name must be unique within an Amazon Web Services account.</p>
|
|
2978
3063
|
*/
|
|
2979
3064
|
AssignmentName: string | undefined;
|
|
2980
3065
|
/**
|
|
@@ -3002,12 +3087,12 @@ export interface UpdateIAMPolicyAssignmentRequest {
|
|
|
3002
3087
|
*/
|
|
3003
3088
|
AssignmentStatus?: AssignmentStatus | string;
|
|
3004
3089
|
/**
|
|
3005
|
-
* <p>The ARN for the
|
|
3090
|
+
* <p>The ARN for the IAMpolicy to apply to the Amazon QuickSight users and groups
|
|
3006
3091
|
* specified in this assignment.</p>
|
|
3007
3092
|
*/
|
|
3008
3093
|
PolicyArn?: string;
|
|
3009
3094
|
/**
|
|
3010
|
-
* <p>The QuickSight users, groups, or both that you want to assign the policy to.</p>
|
|
3095
|
+
* <p>The Amazon QuickSight users, groups, or both that you want to assign the policy to.</p>
|
|
3011
3096
|
*/
|
|
3012
3097
|
Identities?: {
|
|
3013
3098
|
[key: string]: string[];
|
|
@@ -3029,12 +3114,12 @@ export interface UpdateIAMPolicyAssignmentResponse {
|
|
|
3029
3114
|
*/
|
|
3030
3115
|
AssignmentId?: string;
|
|
3031
3116
|
/**
|
|
3032
|
-
* <p>The ARN for the
|
|
3117
|
+
* <p>The ARN for the IAMpolicy applied to the Amazon QuickSight users and groups specified in this
|
|
3033
3118
|
* assignment.</p>
|
|
3034
3119
|
*/
|
|
3035
3120
|
PolicyArn?: string;
|
|
3036
3121
|
/**
|
|
3037
|
-
* <p>The QuickSight users, groups, or both that the
|
|
3122
|
+
* <p>The Amazon QuickSight users, groups, or both that the IAMpolicy is assigned to.</p>
|
|
3038
3123
|
*/
|
|
3039
3124
|
Identities?: {
|
|
3040
3125
|
[key: string]: string[];
|
|
@@ -3076,7 +3161,7 @@ export declare namespace UpdateIAMPolicyAssignmentResponse {
|
|
|
3076
3161
|
}
|
|
3077
3162
|
export interface UpdateTemplateRequest {
|
|
3078
3163
|
/**
|
|
3079
|
-
* <p>The ID of the Amazon Web Services account
|
|
3164
|
+
* <p>The ID of the Amazon Web Services account that contains the template that you're updating.</p>
|
|
3080
3165
|
*/
|
|
3081
3166
|
AwsAccountId: string | undefined;
|
|
3082
3167
|
/**
|
|
@@ -3090,7 +3175,7 @@ export interface UpdateTemplateRequest {
|
|
|
3090
3175
|
* analysis. Both of these require an Amazon Resource Name (ARN). For
|
|
3091
3176
|
* <code>SourceTemplate</code>, specify the ARN of the source template. For
|
|
3092
3177
|
* <code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code>
|
|
3093
|
-
* ARN can contain any Amazon Web Services account
|
|
3178
|
+
* ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;. </p>
|
|
3094
3179
|
* <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or
|
|
3095
3180
|
* <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed
|
|
3096
3181
|
* in the original. The schema in each dataset must match its placeholder. </p>
|
|
@@ -3148,7 +3233,7 @@ export declare namespace UpdateTemplateResponse {
|
|
|
3148
3233
|
}
|
|
3149
3234
|
export interface UpdateTemplateAliasRequest {
|
|
3150
3235
|
/**
|
|
3151
|
-
* <p>The ID of the Amazon Web Services account
|
|
3236
|
+
* <p>The ID of the Amazon Web Services account that contains the template alias that you're updating.</p>
|
|
3152
3237
|
*/
|
|
3153
3238
|
AwsAccountId: string | undefined;
|
|
3154
3239
|
/**
|
|
@@ -3195,7 +3280,7 @@ export declare namespace UpdateTemplateAliasResponse {
|
|
|
3195
3280
|
}
|
|
3196
3281
|
export interface UpdateTemplatePermissionsRequest {
|
|
3197
3282
|
/**
|
|
3198
|
-
* <p>The ID of the Amazon Web Services account
|
|
3283
|
+
* <p>The ID of the Amazon Web Services account that contains the template.</p>
|
|
3199
3284
|
*/
|
|
3200
3285
|
AwsAccountId: string | undefined;
|
|
3201
3286
|
/**
|
|
@@ -3247,7 +3332,7 @@ export declare namespace UpdateTemplatePermissionsResponse {
|
|
|
3247
3332
|
}
|
|
3248
3333
|
export interface UpdateThemeRequest {
|
|
3249
3334
|
/**
|
|
3250
|
-
* <p>The ID of the Amazon Web Services account
|
|
3335
|
+
* <p>The ID of the Amazon Web Services account that contains the theme that you're updating.</p>
|
|
3251
3336
|
*/
|
|
3252
3337
|
AwsAccountId: string | undefined;
|
|
3253
3338
|
/**
|
|
@@ -3314,7 +3399,7 @@ export declare namespace UpdateThemeResponse {
|
|
|
3314
3399
|
}
|
|
3315
3400
|
export interface UpdateThemeAliasRequest {
|
|
3316
3401
|
/**
|
|
3317
|
-
* <p>The ID of the Amazon Web Services account
|
|
3402
|
+
* <p>The ID of the Amazon Web Services account that contains the theme alias that you're updating.</p>
|
|
3318
3403
|
*/
|
|
3319
3404
|
AwsAccountId: string | undefined;
|
|
3320
3405
|
/**
|
|
@@ -3358,7 +3443,7 @@ export declare namespace UpdateThemeAliasResponse {
|
|
|
3358
3443
|
}
|
|
3359
3444
|
export interface UpdateThemePermissionsRequest {
|
|
3360
3445
|
/**
|
|
3361
|
-
* <p>The ID of the Amazon Web Services account
|
|
3446
|
+
* <p>The ID of the Amazon Web Services account that contains the theme.</p>
|
|
3362
3447
|
*/
|
|
3363
3448
|
AwsAccountId: string | undefined;
|
|
3364
3449
|
/**
|
|
@@ -3414,8 +3499,8 @@ export interface UpdateUserRequest {
|
|
|
3414
3499
|
*/
|
|
3415
3500
|
UserName: string | undefined;
|
|
3416
3501
|
/**
|
|
3417
|
-
* <p>The ID for the Amazon Web Services account
|
|
3418
|
-
* Amazon Web Services account
|
|
3502
|
+
* <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the
|
|
3503
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
3419
3504
|
*/
|
|
3420
3505
|
AwsAccountId: string | undefined;
|
|
3421
3506
|
/**
|
|
@@ -3445,7 +3530,7 @@ export interface UpdateUserRequest {
|
|
|
3445
3530
|
* settings.</p>
|
|
3446
3531
|
* </li>
|
|
3447
3532
|
* </ul>
|
|
3448
|
-
* <p>The name of the QuickSight role is invisible to the user except for the console
|
|
3533
|
+
* <p>The name of the Amazon QuickSight role is invisible to the user except for the console
|
|
3449
3534
|
* screens dealing with permissions.</p>
|
|
3450
3535
|
*/
|
|
3451
3536
|
Role: UserRole | string | undefined;
|
|
@@ -3468,13 +3553,13 @@ export interface UpdateUserRequest {
|
|
|
3468
3553
|
* </li>
|
|
3469
3554
|
* </ul>
|
|
3470
3555
|
* <p>A set of custom permissions includes any combination of these restrictions. Currently,
|
|
3471
|
-
* you need to create the profile names for custom permission sets by using the QuickSight
|
|
3556
|
+
* you need to create the profile names for custom permission sets by using the Amazon QuickSight
|
|
3472
3557
|
* console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of
|
|
3473
|
-
* permissions to a QuickSight user. </p>
|
|
3474
|
-
* <p>QuickSight custom permissions are applied through
|
|
3475
|
-
* override the permissions typically granted by assigning QuickSight users to one of the
|
|
3476
|
-
* default security cohorts in QuickSight (admin, author, reader).</p>
|
|
3477
|
-
* <p>This feature is available only to QuickSight Enterprise edition subscriptions.</p>
|
|
3558
|
+
* permissions to a Amazon QuickSight user. </p>
|
|
3559
|
+
* <p>Amazon QuickSight custom permissions are applied through IAMpolicies. Therefore, they
|
|
3560
|
+
* override the permissions typically granted by assigning Amazon QuickSight users to one of the
|
|
3561
|
+
* default security cohorts in Amazon QuickSight (admin, author, reader).</p>
|
|
3562
|
+
* <p>This feature is available only to Amazon QuickSight Enterprise edition subscriptions.</p>
|
|
3478
3563
|
*/
|
|
3479
3564
|
CustomPermissionsName?: string;
|
|
3480
3565
|
/**
|
|
@@ -3485,7 +3570,7 @@ export interface UpdateUserRequest {
|
|
|
3485
3570
|
*/
|
|
3486
3571
|
UnapplyCustomPermissions?: boolean;
|
|
3487
3572
|
/**
|
|
3488
|
-
* <p>The type of supported external login provider that provides identity to let a user federate into QuickSight with an associated
|
|
3573
|
+
* <p>The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.</p>
|
|
3489
3574
|
* <ul>
|
|
3490
3575
|
* <li>
|
|
3491
3576
|
* <p>
|
|
@@ -3506,7 +3591,7 @@ export interface UpdateUserRequest {
|
|
|
3506
3591
|
ExternalLoginFederationProviderType?: string;
|
|
3507
3592
|
/**
|
|
3508
3593
|
* <p>The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate
|
|
3509
|
-
* into QuickSight with an associated
|
|
3594
|
+
* into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should
|
|
3510
3595
|
* only be used when <code>ExternalLoginFederationProviderType</code> parameter is set to <code>CUSTOM_OIDC</code>.</p>
|
|
3511
3596
|
*/
|
|
3512
3597
|
CustomFederationProviderUrl?: string;
|