@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
package/models/models_1.ts
CHANGED
|
@@ -15,19 +15,19 @@ import {
|
|
|
15
15
|
DashboardVersionSummary,
|
|
16
16
|
DataSetImportMode,
|
|
17
17
|
DataSetSummary,
|
|
18
|
+
DataSetUsageConfiguration,
|
|
18
19
|
DataSource,
|
|
19
20
|
DataSourceCredentials,
|
|
20
21
|
DataSourceParameters,
|
|
21
22
|
EmbeddingIdentityType,
|
|
22
23
|
FieldFolder,
|
|
23
|
-
|
|
24
|
-
|
|
24
|
+
FilterOperator,
|
|
25
|
+
FolderType,
|
|
25
26
|
Group,
|
|
26
27
|
GroupMember,
|
|
27
28
|
IdentityType,
|
|
28
29
|
Ingestion,
|
|
29
30
|
LogicalTable,
|
|
30
|
-
MemberIdArnPair,
|
|
31
31
|
NamespaceInfoV2,
|
|
32
32
|
PhysicalTable,
|
|
33
33
|
ResourcePermission,
|
|
@@ -49,6 +49,107 @@ import {
|
|
|
49
49
|
import { SENSITIVE_STRING } from "@aws-sdk/smithy-client";
|
|
50
50
|
import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
|
|
51
51
|
|
|
52
|
+
export enum FolderFilterAttribute {
|
|
53
|
+
PARENT_FOLDER_ARN = "PARENT_FOLDER_ARN",
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* <p>An object that consists of the member Amazon Resource Name (ARN) and member ID.</p>
|
|
58
|
+
*/
|
|
59
|
+
export interface MemberIdArnPair {
|
|
60
|
+
/**
|
|
61
|
+
* <p>The ID of the member.</p>
|
|
62
|
+
*/
|
|
63
|
+
MemberId?: string;
|
|
64
|
+
|
|
65
|
+
/**
|
|
66
|
+
* <p>The Amazon Resource Name (ARN) of the member.</p>
|
|
67
|
+
*/
|
|
68
|
+
MemberArn?: string;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
export namespace MemberIdArnPair {
|
|
72
|
+
/**
|
|
73
|
+
* @internal
|
|
74
|
+
*/
|
|
75
|
+
export const filterSensitiveLog = (obj: MemberIdArnPair): any => ({
|
|
76
|
+
...obj,
|
|
77
|
+
});
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
/**
|
|
81
|
+
* <p>Searches a folder by a filter.</p>
|
|
82
|
+
*/
|
|
83
|
+
export interface FolderSearchFilter {
|
|
84
|
+
/**
|
|
85
|
+
* <p>The comparison operator that you want to use as a filter. For example, <code>"Operator": "StringEquals"</code>.</p>
|
|
86
|
+
*/
|
|
87
|
+
Operator?: FilterOperator | string;
|
|
88
|
+
|
|
89
|
+
/**
|
|
90
|
+
* <p>The name of the value that you want to use as a filter. For example, <code>"Name": "PARENT_FOLDER_ARN"</code>.</p>
|
|
91
|
+
*/
|
|
92
|
+
Name?: FolderFilterAttribute | string;
|
|
93
|
+
|
|
94
|
+
/**
|
|
95
|
+
* <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>
|
|
96
|
+
*/
|
|
97
|
+
Value?: string;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
export namespace FolderSearchFilter {
|
|
101
|
+
/**
|
|
102
|
+
* @internal
|
|
103
|
+
*/
|
|
104
|
+
export const filterSensitiveLog = (obj: FolderSearchFilter): any => ({
|
|
105
|
+
...obj,
|
|
106
|
+
});
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
/**
|
|
110
|
+
* <p>A summary of the folder. </p>
|
|
111
|
+
*/
|
|
112
|
+
export interface FolderSummary {
|
|
113
|
+
/**
|
|
114
|
+
* <p>The Amazon Resource Name (ARN).</p>
|
|
115
|
+
*/
|
|
116
|
+
Arn?: string;
|
|
117
|
+
|
|
118
|
+
/**
|
|
119
|
+
* <p>The folder ID.</p>
|
|
120
|
+
*/
|
|
121
|
+
FolderId?: string;
|
|
122
|
+
|
|
123
|
+
/**
|
|
124
|
+
* <p>The display name of the folder.</p>
|
|
125
|
+
*/
|
|
126
|
+
Name?: string;
|
|
127
|
+
|
|
128
|
+
/**
|
|
129
|
+
* <p>The type of folder.</p>
|
|
130
|
+
*/
|
|
131
|
+
FolderType?: FolderType | string;
|
|
132
|
+
|
|
133
|
+
/**
|
|
134
|
+
* <p>The time that the folder was created.</p>
|
|
135
|
+
*/
|
|
136
|
+
CreatedTime?: Date;
|
|
137
|
+
|
|
138
|
+
/**
|
|
139
|
+
* <p>The time that the folder was last updated.</p>
|
|
140
|
+
*/
|
|
141
|
+
LastUpdatedTime?: Date;
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
export namespace FolderSummary {
|
|
145
|
+
/**
|
|
146
|
+
* @internal
|
|
147
|
+
*/
|
|
148
|
+
export const filterSensitiveLog = (obj: FolderSummary): any => ({
|
|
149
|
+
...obj,
|
|
150
|
+
});
|
|
151
|
+
}
|
|
152
|
+
|
|
52
153
|
/**
|
|
53
154
|
* <p>The key-value pair used for the row-level security tags feature.</p>
|
|
54
155
|
*/
|
|
@@ -170,9 +271,9 @@ export namespace SessionLifetimeInMinutesInvalidException {
|
|
|
170
271
|
|
|
171
272
|
/**
|
|
172
273
|
* <p>This error indicates that you are calling an embedding operation in Amazon QuickSight
|
|
173
|
-
* without the required pricing plan on your Amazon Web Services account
|
|
174
|
-
* for anonymous users, a QuickSight administrator needs to add capacity pricing to QuickSight. You
|
|
175
|
-
* can do this on the <b>Manage QuickSight</b> page. </p>
|
|
274
|
+
* without the required pricing plan on your Amazon Web Services account. Before you can use embedding
|
|
275
|
+
* for anonymous users, a Amazon QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You
|
|
276
|
+
* can do this on the <b>Manage Amazon QuickSight</b> page. </p>
|
|
176
277
|
* <p>After capacity pricing is added, you can use the
|
|
177
278
|
* <a>GetDashboardEmbedUrl</a> API operation with the
|
|
178
279
|
* <code>--identity-type ANONYMOUS</code> option.</p>
|
|
@@ -403,7 +504,7 @@ export namespace QuickSightUserNotFoundException {
|
|
|
403
504
|
|
|
404
505
|
export interface GetDashboardEmbedUrlRequest {
|
|
405
506
|
/**
|
|
406
|
-
* <p>The ID for the Amazon Web Services account
|
|
507
|
+
* <p>The ID for the Amazon Web Services account that contains the dashboard that you're embedding.</p>
|
|
407
508
|
*/
|
|
408
509
|
AwsAccountId: string | undefined;
|
|
409
510
|
|
|
@@ -438,9 +539,9 @@ export interface GetDashboardEmbedUrlRequest {
|
|
|
438
539
|
/**
|
|
439
540
|
* <p>Adds persistence of state for the user session in an embedded dashboard. Persistence
|
|
440
541
|
* applies to the sheet and the parameter settings. These are control settings that the
|
|
441
|
-
* dashboard subscriber (QuickSight reader) chooses while viewing the dashboard. If this is
|
|
542
|
+
* dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is
|
|
442
543
|
* set to <code>TRUE</code>, the settings are the same when the subscriber reopens the same
|
|
443
|
-
* dashboard URL. The state is stored in QuickSight, not in a browser cookie. If this is
|
|
544
|
+
* dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is
|
|
444
545
|
* set to FALSE, the state of the user session is not persisted. The default is
|
|
445
546
|
* <code>FALSE</code>.</p>
|
|
446
547
|
*/
|
|
@@ -458,17 +559,18 @@ export interface GetDashboardEmbedUrlRequest {
|
|
|
458
559
|
* <p>Invited nonfederated users</p>
|
|
459
560
|
* </li>
|
|
460
561
|
* <li>
|
|
461
|
-
* <p>
|
|
462
|
-
* SAML, OpenID Connect, or
|
|
562
|
+
* <p>IAMusers and IAMrole-based sessions authenticated through Federated Single Sign-On using
|
|
563
|
+
* SAML, OpenID Connect, or IAMfederation.</p>
|
|
463
564
|
* </li>
|
|
464
565
|
* </ul>
|
|
465
|
-
* <p>Omit this parameter for users in the third group –
|
|
566
|
+
* <p>Omit this parameter for users in the third group – IAMusers and IAM
|
|
466
567
|
* role-based sessions.</p>
|
|
467
568
|
*/
|
|
468
569
|
UserArn?: string;
|
|
469
570
|
|
|
470
571
|
/**
|
|
471
|
-
* <p>The Amazon QuickSight namespace that the
|
|
572
|
+
* <p>The Amazon QuickSight namespace that contains the dashboard IDs in this request.
|
|
573
|
+
* If you're not using a custom namespace, set <code>Namespace = default</code>.</p>
|
|
472
574
|
*/
|
|
473
575
|
Namespace?: string;
|
|
474
576
|
|
|
@@ -476,7 +578,7 @@ export interface GetDashboardEmbedUrlRequest {
|
|
|
476
578
|
* <p>A list of one or more dashboard IDs that you want to add to a session that includes
|
|
477
579
|
* anonymous users. The <code>IdentityType</code> parameter must be set to
|
|
478
580
|
* <code>ANONYMOUS</code> for this to work, because other identity types authenticate
|
|
479
|
-
* as QuickSight or
|
|
581
|
+
* as Amazon QuickSight or IAMusers. For example, if you set "<code>--dashboard-id dash_id1
|
|
480
582
|
* --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS</code>", the session
|
|
481
583
|
* can access all three dashboards. </p>
|
|
482
584
|
*/
|
|
@@ -550,7 +652,7 @@ export namespace IdentityTypeNotSupportedException {
|
|
|
550
652
|
|
|
551
653
|
export interface GetSessionEmbedUrlRequest {
|
|
552
654
|
/**
|
|
553
|
-
* <p>The ID for the Amazon Web Services account
|
|
655
|
+
* <p>The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.</p>
|
|
554
656
|
*/
|
|
555
657
|
AwsAccountId: string | undefined;
|
|
556
658
|
|
|
@@ -581,12 +683,12 @@ export interface GetSessionEmbedUrlRequest {
|
|
|
581
683
|
* <li>
|
|
582
684
|
* <p>
|
|
583
685
|
* <code>/dashboards/<i>DashboardId</i>
|
|
584
|
-
* </code> - where <code>DashboardId</code> is the actual ID key from the QuickSight console URL of the dashboard</p>
|
|
686
|
+
* </code> - where <code>DashboardId</code> is the actual ID key from the Amazon QuickSight console URL of the dashboard</p>
|
|
585
687
|
* </li>
|
|
586
688
|
* <li>
|
|
587
689
|
* <p>
|
|
588
690
|
* <code>/analyses/<i>AnalysisId</i>
|
|
589
|
-
* </code> - where <code>AnalysisId</code> is the actual ID key from the QuickSight console URL of the analysis</p>
|
|
691
|
+
* </code> - where <code>AnalysisId</code> is the actual ID key from the Amazon QuickSight console URL of the analysis</p>
|
|
590
692
|
* </li>
|
|
591
693
|
* </ul>
|
|
592
694
|
*/
|
|
@@ -632,7 +734,7 @@ export namespace GetSessionEmbedUrlRequest {
|
|
|
632
734
|
export interface GetSessionEmbedUrlResponse {
|
|
633
735
|
/**
|
|
634
736
|
* <p>A single-use URL that you can put into your server-side web page to embed your
|
|
635
|
-
* QuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an
|
|
737
|
+
* Amazon QuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an
|
|
636
738
|
* <code>auth_code</code> value that enables one (and only one) sign-on to a user session
|
|
637
739
|
* that is valid for 10 hours. </p>
|
|
638
740
|
*/
|
|
@@ -660,7 +762,7 @@ export namespace GetSessionEmbedUrlResponse {
|
|
|
660
762
|
}
|
|
661
763
|
|
|
662
764
|
/**
|
|
663
|
-
* <p>
|
|
765
|
+
* <p>IAMpolicy assignment summary.</p>
|
|
664
766
|
*/
|
|
665
767
|
export interface IAMPolicyAssignmentSummary {
|
|
666
768
|
/**
|
|
@@ -685,7 +787,7 @@ export namespace IAMPolicyAssignmentSummary {
|
|
|
685
787
|
|
|
686
788
|
export interface ListAnalysesRequest {
|
|
687
789
|
/**
|
|
688
|
-
* <p>The ID of the Amazon Web Services account
|
|
790
|
+
* <p>The ID of the Amazon Web Services account that contains the analyses.</p>
|
|
689
791
|
*/
|
|
690
792
|
AwsAccountId: string | undefined;
|
|
691
793
|
|
|
@@ -742,7 +844,7 @@ export namespace ListAnalysesResponse {
|
|
|
742
844
|
|
|
743
845
|
export interface ListDashboardsRequest {
|
|
744
846
|
/**
|
|
745
|
-
* <p>The ID of the Amazon Web Services account
|
|
847
|
+
* <p>The ID of the Amazon Web Services account that contains the dashboards that you're
|
|
746
848
|
* listing.</p>
|
|
747
849
|
*/
|
|
748
850
|
AwsAccountId: string | undefined;
|
|
@@ -769,7 +871,7 @@ export namespace ListDashboardsRequest {
|
|
|
769
871
|
|
|
770
872
|
export interface ListDashboardsResponse {
|
|
771
873
|
/**
|
|
772
|
-
* <p>A structure that contains all of the dashboards in your Amazon Web Services account
|
|
874
|
+
* <p>A structure that contains all of the dashboards in your Amazon Web Services account. This structure
|
|
773
875
|
* provides basic information about the dashboards.</p>
|
|
774
876
|
*/
|
|
775
877
|
DashboardSummaryList?: DashboardSummary[];
|
|
@@ -801,7 +903,7 @@ export namespace ListDashboardsResponse {
|
|
|
801
903
|
|
|
802
904
|
export interface ListDashboardVersionsRequest {
|
|
803
905
|
/**
|
|
804
|
-
* <p>The ID of the Amazon Web Services account
|
|
906
|
+
* <p>The ID of the Amazon Web Services account that contains the dashboard that you're listing versions
|
|
805
907
|
* for.</p>
|
|
806
908
|
*/
|
|
807
909
|
AwsAccountId: string | undefined;
|
|
@@ -864,7 +966,7 @@ export namespace ListDashboardVersionsResponse {
|
|
|
864
966
|
|
|
865
967
|
export interface ListDataSetsRequest {
|
|
866
968
|
/**
|
|
867
|
-
* <p>The Amazon Web Services account
|
|
969
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
868
970
|
*/
|
|
869
971
|
AwsAccountId: string | undefined;
|
|
870
972
|
|
|
@@ -921,7 +1023,7 @@ export namespace ListDataSetsResponse {
|
|
|
921
1023
|
|
|
922
1024
|
export interface ListDataSourcesRequest {
|
|
923
1025
|
/**
|
|
924
|
-
* <p>The Amazon Web Services account
|
|
1026
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
925
1027
|
*/
|
|
926
1028
|
AwsAccountId: string | undefined;
|
|
927
1029
|
|
|
@@ -1115,8 +1217,8 @@ export interface ListGroupMembershipsRequest {
|
|
|
1115
1217
|
MaxResults?: number;
|
|
1116
1218
|
|
|
1117
1219
|
/**
|
|
1118
|
-
* <p>The ID for the Amazon Web Services account
|
|
1119
|
-
* Amazon Web Services account
|
|
1220
|
+
* <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
|
|
1221
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
1120
1222
|
*/
|
|
1121
1223
|
AwsAccountId: string | undefined;
|
|
1122
1224
|
|
|
@@ -1168,8 +1270,8 @@ export namespace ListGroupMembershipsResponse {
|
|
|
1168
1270
|
|
|
1169
1271
|
export interface ListGroupsRequest {
|
|
1170
1272
|
/**
|
|
1171
|
-
* <p>The ID for the Amazon Web Services account
|
|
1172
|
-
* Amazon Web Services account
|
|
1273
|
+
* <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
|
|
1274
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
1173
1275
|
*/
|
|
1174
1276
|
AwsAccountId: string | undefined;
|
|
1175
1277
|
|
|
@@ -1231,7 +1333,7 @@ export namespace ListGroupsResponse {
|
|
|
1231
1333
|
|
|
1232
1334
|
export interface ListIAMPolicyAssignmentsRequest {
|
|
1233
1335
|
/**
|
|
1234
|
-
* <p>The ID of the Amazon Web Services account
|
|
1336
|
+
* <p>The ID of the Amazon Web Services account that contains these IAMpolicy assignments.</p>
|
|
1235
1337
|
*/
|
|
1236
1338
|
AwsAccountId: string | undefined;
|
|
1237
1339
|
|
|
@@ -1267,7 +1369,7 @@ export namespace ListIAMPolicyAssignmentsRequest {
|
|
|
1267
1369
|
|
|
1268
1370
|
export interface ListIAMPolicyAssignmentsResponse {
|
|
1269
1371
|
/**
|
|
1270
|
-
* <p>Information describing the
|
|
1372
|
+
* <p>Information describing the IAMpolicy assignments.</p>
|
|
1271
1373
|
*/
|
|
1272
1374
|
IAMPolicyAssignments?: IAMPolicyAssignmentSummary[];
|
|
1273
1375
|
|
|
@@ -1298,7 +1400,7 @@ export namespace ListIAMPolicyAssignmentsResponse {
|
|
|
1298
1400
|
|
|
1299
1401
|
export interface ListIAMPolicyAssignmentsForUserRequest {
|
|
1300
1402
|
/**
|
|
1301
|
-
* <p>The ID of the Amazon Web Services account
|
|
1403
|
+
* <p>The ID of the Amazon Web Services account that contains the assignments.</p>
|
|
1302
1404
|
*/
|
|
1303
1405
|
AwsAccountId: string | undefined;
|
|
1304
1406
|
|
|
@@ -1375,7 +1477,7 @@ export interface ListIngestionsRequest {
|
|
|
1375
1477
|
NextToken?: string;
|
|
1376
1478
|
|
|
1377
1479
|
/**
|
|
1378
|
-
* <p>The Amazon Web Services account
|
|
1480
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
1379
1481
|
*/
|
|
1380
1482
|
AwsAccountId: string | undefined;
|
|
1381
1483
|
|
|
@@ -1427,7 +1529,7 @@ export namespace ListIngestionsResponse {
|
|
|
1427
1529
|
|
|
1428
1530
|
export interface ListNamespacesRequest {
|
|
1429
1531
|
/**
|
|
1430
|
-
* <p>The ID for the Amazon Web Services account
|
|
1532
|
+
* <p>The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.</p>
|
|
1431
1533
|
*/
|
|
1432
1534
|
AwsAccountId: string | undefined;
|
|
1433
1535
|
|
|
@@ -1453,7 +1555,7 @@ export namespace ListNamespacesRequest {
|
|
|
1453
1555
|
|
|
1454
1556
|
export interface ListNamespacesResponse {
|
|
1455
1557
|
/**
|
|
1456
|
-
* <p>The information about the namespaces in this Amazon Web Services account
|
|
1558
|
+
* <p>The information about the namespaces in this Amazon Web Services account. The response includes
|
|
1457
1559
|
* the namespace ARN, name, Amazon Web Services Region;, notification email address, creation status, and
|
|
1458
1560
|
* identity store.</p>
|
|
1459
1561
|
*/
|
|
@@ -1529,7 +1631,7 @@ export namespace ListTagsForResourceResponse {
|
|
|
1529
1631
|
|
|
1530
1632
|
export interface ListTemplateAliasesRequest {
|
|
1531
1633
|
/**
|
|
1532
|
-
* <p>The ID of the Amazon Web Services account
|
|
1634
|
+
* <p>The ID of the Amazon Web Services account that contains the template aliases that you're listing.</p>
|
|
1533
1635
|
*/
|
|
1534
1636
|
AwsAccountId: string | undefined;
|
|
1535
1637
|
|
|
@@ -1591,7 +1693,7 @@ export namespace ListTemplateAliasesResponse {
|
|
|
1591
1693
|
|
|
1592
1694
|
export interface ListTemplatesRequest {
|
|
1593
1695
|
/**
|
|
1594
|
-
* <p>The ID of the Amazon Web Services account
|
|
1696
|
+
* <p>The ID of the Amazon Web Services account that contains the templates that you're listing.</p>
|
|
1595
1697
|
*/
|
|
1596
1698
|
AwsAccountId: string | undefined;
|
|
1597
1699
|
|
|
@@ -1625,7 +1727,7 @@ export interface TemplateSummary {
|
|
|
1625
1727
|
Arn?: string;
|
|
1626
1728
|
|
|
1627
1729
|
/**
|
|
1628
|
-
* <p>The ID of the template. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
1730
|
+
* <p>The ID of the template. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.</p>
|
|
1629
1731
|
*/
|
|
1630
1732
|
TemplateId?: string;
|
|
1631
1733
|
|
|
@@ -1692,7 +1794,7 @@ export namespace ListTemplatesResponse {
|
|
|
1692
1794
|
|
|
1693
1795
|
export interface ListTemplateVersionsRequest {
|
|
1694
1796
|
/**
|
|
1695
|
-
* <p>The ID of the Amazon Web Services account
|
|
1797
|
+
* <p>The ID of the Amazon Web Services account that contains the templates that you're listing.</p>
|
|
1696
1798
|
*/
|
|
1697
1799
|
AwsAccountId: string | undefined;
|
|
1698
1800
|
|
|
@@ -1793,7 +1895,7 @@ export namespace ListTemplateVersionsResponse {
|
|
|
1793
1895
|
|
|
1794
1896
|
export interface ListThemeAliasesRequest {
|
|
1795
1897
|
/**
|
|
1796
|
-
* <p>The ID of the Amazon Web Services account
|
|
1898
|
+
* <p>The ID of the Amazon Web Services account that contains the theme aliases that you're listing.</p>
|
|
1797
1899
|
*/
|
|
1798
1900
|
AwsAccountId: string | undefined;
|
|
1799
1901
|
|
|
@@ -1855,7 +1957,7 @@ export namespace ListThemeAliasesResponse {
|
|
|
1855
1957
|
|
|
1856
1958
|
export interface ListThemesRequest {
|
|
1857
1959
|
/**
|
|
1858
|
-
* <p>The ID of the Amazon Web Services account
|
|
1960
|
+
* <p>The ID of the Amazon Web Services account that contains the themes that you're listing.</p>
|
|
1859
1961
|
*/
|
|
1860
1962
|
AwsAccountId: string | undefined;
|
|
1861
1963
|
|
|
@@ -1913,7 +2015,7 @@ export interface ThemeSummary {
|
|
|
1913
2015
|
Name?: string;
|
|
1914
2016
|
|
|
1915
2017
|
/**
|
|
1916
|
-
* <p>The ID of the theme. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
2018
|
+
* <p>The ID of the theme. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.</p>
|
|
1917
2019
|
*/
|
|
1918
2020
|
ThemeId?: string;
|
|
1919
2021
|
|
|
@@ -1975,7 +2077,7 @@ export namespace ListThemesResponse {
|
|
|
1975
2077
|
|
|
1976
2078
|
export interface ListThemeVersionsRequest {
|
|
1977
2079
|
/**
|
|
1978
|
-
* <p>The ID of the Amazon Web Services account
|
|
2080
|
+
* <p>The ID of the Amazon Web Services account that contains the themes that you're listing.</p>
|
|
1979
2081
|
*/
|
|
1980
2082
|
AwsAccountId: string | undefined;
|
|
1981
2083
|
|
|
@@ -2081,7 +2183,7 @@ export interface ListUserGroupsRequest {
|
|
|
2081
2183
|
UserName: string | undefined;
|
|
2082
2184
|
|
|
2083
2185
|
/**
|
|
2084
|
-
* <p>The Amazon Web Services account
|
|
2186
|
+
* <p>The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account
|
|
2085
2187
|
* that contains your Amazon QuickSight account.</p>
|
|
2086
2188
|
*/
|
|
2087
2189
|
AwsAccountId: string | undefined;
|
|
@@ -2144,8 +2246,8 @@ export namespace ListUserGroupsResponse {
|
|
|
2144
2246
|
|
|
2145
2247
|
export interface ListUsersRequest {
|
|
2146
2248
|
/**
|
|
2147
|
-
* <p>The ID for the Amazon Web Services account
|
|
2148
|
-
* Amazon Web Services account
|
|
2249
|
+
* <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the
|
|
2250
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
2149
2251
|
*/
|
|
2150
2252
|
AwsAccountId: string | undefined;
|
|
2151
2253
|
|
|
@@ -2212,7 +2314,7 @@ export interface RegisterUserRequest {
|
|
|
2212
2314
|
* <ul>
|
|
2213
2315
|
* <li>
|
|
2214
2316
|
* <p>
|
|
2215
|
-
* <code>IAM</code>: A user whose identity maps to an existing
|
|
2317
|
+
* <code>IAM</code>: A user whose identity maps to an existing IAMuser or role.
|
|
2216
2318
|
* </p>
|
|
2217
2319
|
* </li>
|
|
2218
2320
|
* <li>
|
|
@@ -2262,16 +2364,16 @@ export interface RegisterUserRequest {
|
|
|
2262
2364
|
UserRole: UserRole | string | undefined;
|
|
2263
2365
|
|
|
2264
2366
|
/**
|
|
2265
|
-
* <p>The ARN of the
|
|
2367
|
+
* <p>The ARN of the IAMuser or role that you are registering with Amazon QuickSight. </p>
|
|
2266
2368
|
*/
|
|
2267
2369
|
IamArn?: string;
|
|
2268
2370
|
|
|
2269
2371
|
/**
|
|
2270
2372
|
* <p>You need to use this parameter only when you register one or more users using an assumed
|
|
2271
|
-
*
|
|
2272
|
-
* you are registering an
|
|
2273
|
-
* users using the same
|
|
2274
|
-
* information on assuming
|
|
2373
|
+
* IAMrole. You don't need to provide the session name for other scenarios, for example when
|
|
2374
|
+
* you are registering an IAMuser or an Amazon QuickSight user. You can register multiple
|
|
2375
|
+
* users using the same IAMrole if each user has a different session name. For more
|
|
2376
|
+
* information on assuming IAMroles, see <a href="https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html">
|
|
2275
2377
|
* <code>assume-role</code>
|
|
2276
2378
|
* </a> in the <i>AWS CLI Reference.</i>
|
|
2277
2379
|
* </p>
|
|
@@ -2279,8 +2381,8 @@ export interface RegisterUserRequest {
|
|
|
2279
2381
|
SessionName?: string;
|
|
2280
2382
|
|
|
2281
2383
|
/**
|
|
2282
|
-
* <p>The ID for the Amazon Web Services account
|
|
2283
|
-
* Amazon Web Services account
|
|
2384
|
+
* <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the
|
|
2385
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
2284
2386
|
*/
|
|
2285
2387
|
AwsAccountId: string | undefined;
|
|
2286
2388
|
|
|
@@ -2317,18 +2419,18 @@ export interface RegisterUserRequest {
|
|
|
2317
2419
|
* <a>UpdateUser</a>
|
|
2318
2420
|
* </code> instead.</p>
|
|
2319
2421
|
* <p>A set of custom permissions includes any combination of these restrictions. Currently,
|
|
2320
|
-
* you need to create the profile names for custom permission sets by using the QuickSight
|
|
2422
|
+
* you need to create the profile names for custom permission sets by using the Amazon QuickSight
|
|
2321
2423
|
* console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of
|
|
2322
|
-
* permissions to a QuickSight user. </p>
|
|
2323
|
-
* <p>QuickSight custom permissions are applied through
|
|
2324
|
-
* override the permissions typically granted by assigning QuickSight users to one of the
|
|
2325
|
-
* default security cohorts in QuickSight (admin, author, reader).</p>
|
|
2326
|
-
* <p>This feature is available only to QuickSight Enterprise edition subscriptions.</p>
|
|
2424
|
+
* permissions to a Amazon QuickSight user. </p>
|
|
2425
|
+
* <p>Amazon QuickSight custom permissions are applied through IAMpolicies. Therefore, they
|
|
2426
|
+
* override the permissions typically granted by assigning Amazon QuickSight users to one of the
|
|
2427
|
+
* default security cohorts in Amazon QuickSight (admin, author, reader).</p>
|
|
2428
|
+
* <p>This feature is available only to Amazon QuickSight Enterprise edition subscriptions.</p>
|
|
2327
2429
|
*/
|
|
2328
2430
|
CustomPermissionsName?: string;
|
|
2329
2431
|
|
|
2330
2432
|
/**
|
|
2331
|
-
* <p>The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated
|
|
2433
|
+
* <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>
|
|
2332
2434
|
* <ul>
|
|
2333
2435
|
* <li>
|
|
2334
2436
|
* <p>
|
|
@@ -2344,7 +2446,7 @@ export interface RegisterUserRequest {
|
|
|
2344
2446
|
|
|
2345
2447
|
/**
|
|
2346
2448
|
* <p>The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate
|
|
2347
|
-
* into QuickSight with an associated
|
|
2449
|
+
* into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should
|
|
2348
2450
|
* only be used when <code>ExternalLoginFederationProviderType</code> parameter is set to <code>CUSTOM_OIDC</code>.</p>
|
|
2349
2451
|
*/
|
|
2350
2452
|
CustomFederationProviderUrl?: string;
|
|
@@ -2398,7 +2500,7 @@ export namespace RegisterUserResponse {
|
|
|
2398
2500
|
|
|
2399
2501
|
export interface RestoreAnalysisRequest {
|
|
2400
2502
|
/**
|
|
2401
|
-
* <p>The ID of the Amazon Web Services account
|
|
2503
|
+
* <p>The ID of the Amazon Web Services account that contains the analysis.</p>
|
|
2402
2504
|
*/
|
|
2403
2505
|
AwsAccountId: string | undefined;
|
|
2404
2506
|
|
|
@@ -2451,7 +2553,7 @@ export namespace RestoreAnalysisResponse {
|
|
|
2451
2553
|
|
|
2452
2554
|
export interface SearchAnalysesRequest {
|
|
2453
2555
|
/**
|
|
2454
|
-
* <p>The ID of the Amazon Web Services account
|
|
2556
|
+
* <p>The ID of the Amazon Web Services account that contains the analyses that you're searching
|
|
2455
2557
|
* for.</p>
|
|
2456
2558
|
*/
|
|
2457
2559
|
AwsAccountId: string | undefined;
|
|
@@ -2515,7 +2617,7 @@ export namespace SearchAnalysesResponse {
|
|
|
2515
2617
|
|
|
2516
2618
|
export interface SearchDashboardsRequest {
|
|
2517
2619
|
/**
|
|
2518
|
-
* <p>The ID of the Amazon Web Services account
|
|
2620
|
+
* <p>The ID of the Amazon Web Services account that contains the user whose dashboards you're searching
|
|
2519
2621
|
* for. </p>
|
|
2520
2622
|
*/
|
|
2521
2623
|
AwsAccountId: string | undefined;
|
|
@@ -2728,18 +2830,18 @@ export namespace UntagResourceResponse {
|
|
|
2728
2830
|
|
|
2729
2831
|
export interface UpdateAccountCustomizationRequest {
|
|
2730
2832
|
/**
|
|
2731
|
-
* <p>The ID for the Amazon Web Services account
|
|
2833
|
+
* <p>The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations
|
|
2732
2834
|
* for.</p>
|
|
2733
2835
|
*/
|
|
2734
2836
|
AwsAccountId: string | undefined;
|
|
2735
2837
|
|
|
2736
2838
|
/**
|
|
2737
|
-
* <p>The namespace that you want to update QuickSight customizations for.</p>
|
|
2839
|
+
* <p>The namespace that you want to update Amazon QuickSight customizations for.</p>
|
|
2738
2840
|
*/
|
|
2739
2841
|
Namespace?: string;
|
|
2740
2842
|
|
|
2741
2843
|
/**
|
|
2742
|
-
* <p>The QuickSight customizations you're updating in the current Amazon Web Services Region;. </p>
|
|
2844
|
+
* <p>The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region;. </p>
|
|
2743
2845
|
*/
|
|
2744
2846
|
AccountCustomization: AccountCustomization | undefined;
|
|
2745
2847
|
}
|
|
@@ -2755,12 +2857,12 @@ export namespace UpdateAccountCustomizationRequest {
|
|
|
2755
2857
|
|
|
2756
2858
|
export interface UpdateAccountCustomizationResponse {
|
|
2757
2859
|
/**
|
|
2758
|
-
* <p>The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account
|
|
2860
|
+
* <p>The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account.</p>
|
|
2759
2861
|
*/
|
|
2760
2862
|
Arn?: string;
|
|
2761
2863
|
|
|
2762
2864
|
/**
|
|
2763
|
-
* <p>The ID for the Amazon Web Services account
|
|
2865
|
+
* <p>The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations
|
|
2764
2866
|
* for.</p>
|
|
2765
2867
|
*/
|
|
2766
2868
|
AwsAccountId?: string;
|
|
@@ -2771,7 +2873,7 @@ export interface UpdateAccountCustomizationResponse {
|
|
|
2771
2873
|
Namespace?: string;
|
|
2772
2874
|
|
|
2773
2875
|
/**
|
|
2774
|
-
* <p>The QuickSight customizations you're updating in the current Amazon Web Services Region;. </p>
|
|
2876
|
+
* <p>The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region;. </p>
|
|
2775
2877
|
*/
|
|
2776
2878
|
AccountCustomization?: AccountCustomization;
|
|
2777
2879
|
|
|
@@ -2797,22 +2899,22 @@ export namespace UpdateAccountCustomizationResponse {
|
|
|
2797
2899
|
|
|
2798
2900
|
export interface UpdateAccountSettingsRequest {
|
|
2799
2901
|
/**
|
|
2800
|
-
* <p>The ID for the Amazon Web Services account
|
|
2902
|
+
* <p>The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to
|
|
2801
2903
|
* list.</p>
|
|
2802
2904
|
*/
|
|
2803
2905
|
AwsAccountId: string | undefined;
|
|
2804
2906
|
|
|
2805
2907
|
/**
|
|
2806
|
-
* <p>The default namespace for this Amazon Web Services account
|
|
2908
|
+
* <p>The default namespace for this Amazon Web Services account. Currently, the default is
|
|
2807
2909
|
* <code>default</code>. Identity and Access Management (IAM) users that register
|
|
2808
|
-
* for the first time with QuickSight provide an email that becomes associated with the
|
|
2910
|
+
* for the first time with Amazon QuickSight provide an email that becomes associated with the
|
|
2809
2911
|
* default namespace.</p>
|
|
2810
2912
|
*/
|
|
2811
2913
|
DefaultNamespace: string | undefined;
|
|
2812
2914
|
|
|
2813
2915
|
/**
|
|
2814
|
-
* <p>The email address that you want QuickSight to send notifications to regarding your
|
|
2815
|
-
* Amazon Web Services account
|
|
2916
|
+
* <p>The email address that you want Amazon QuickSight to send notifications to regarding your
|
|
2917
|
+
* Amazon Web Services account or Amazon QuickSight subscription.</p>
|
|
2816
2918
|
*/
|
|
2817
2919
|
NotificationEmail?: string;
|
|
2818
2920
|
}
|
|
@@ -2849,7 +2951,7 @@ export namespace UpdateAccountSettingsResponse {
|
|
|
2849
2951
|
|
|
2850
2952
|
export interface UpdateAnalysisRequest {
|
|
2851
2953
|
/**
|
|
2852
|
-
* <p>The ID of the Amazon Web Services account
|
|
2954
|
+
* <p>The ID of the Amazon Web Services account that contains the analysis that you're updating.</p>
|
|
2853
2955
|
*/
|
|
2854
2956
|
AwsAccountId: string | undefined;
|
|
2855
2957
|
|
|
@@ -2861,7 +2963,7 @@ export interface UpdateAnalysisRequest {
|
|
|
2861
2963
|
|
|
2862
2964
|
/**
|
|
2863
2965
|
* <p>A descriptive name for the analysis that you're updating. This name displays for the
|
|
2864
|
-
* analysis in the QuickSight console.</p>
|
|
2966
|
+
* analysis in the Amazon QuickSight console.</p>
|
|
2865
2967
|
*/
|
|
2866
2968
|
Name: string | undefined;
|
|
2867
2969
|
|
|
@@ -2879,7 +2981,7 @@ export interface UpdateAnalysisRequest {
|
|
|
2879
2981
|
|
|
2880
2982
|
/**
|
|
2881
2983
|
* <p>The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're
|
|
2882
|
-
* creating. To see the theme in the QuickSight console, make sure that you have access to
|
|
2984
|
+
* creating. To see the theme in the Amazon QuickSight console, make sure that you have access to
|
|
2883
2985
|
* it.</p>
|
|
2884
2986
|
*/
|
|
2885
2987
|
ThemeArn?: string;
|
|
@@ -2932,8 +3034,8 @@ export namespace UpdateAnalysisResponse {
|
|
|
2932
3034
|
|
|
2933
3035
|
export interface UpdateAnalysisPermissionsRequest {
|
|
2934
3036
|
/**
|
|
2935
|
-
* <p>The ID of the Amazon Web Services account
|
|
2936
|
-
* updating. You must be using the Amazon Web Services account
|
|
3037
|
+
* <p>The ID of the Amazon Web Services account that contains the analysis whose permissions you're
|
|
3038
|
+
* updating. You must be using the Amazon Web Services account that the analysis is in.</p>
|
|
2937
3039
|
*/
|
|
2938
3040
|
AwsAccountId: string | undefined;
|
|
2939
3041
|
|
|
@@ -3004,7 +3106,7 @@ export namespace UpdateAnalysisPermissionsResponse {
|
|
|
3004
3106
|
|
|
3005
3107
|
export interface UpdateDashboardRequest {
|
|
3006
3108
|
/**
|
|
3007
|
-
* <p>The ID of the Amazon Web Services account
|
|
3109
|
+
* <p>The ID of the Amazon Web Services account that contains the dashboard that you're
|
|
3008
3110
|
* updating.</p>
|
|
3009
3111
|
*/
|
|
3010
3112
|
AwsAccountId: string | undefined;
|
|
@@ -3026,8 +3128,8 @@ export interface UpdateDashboardRequest {
|
|
|
3026
3128
|
* entity. If you need to update a dashboard from an analysis, first convert the analysis
|
|
3027
3129
|
* to a template by using the <a>CreateTemplate</a> API operation. For
|
|
3028
3130
|
* <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source
|
|
3029
|
-
* template. The <code>SourceTemplate</code> ARN can contain any Amazon Web Services account
|
|
3030
|
-
* QuickSight-supported Amazon Web Services Region;. </p>
|
|
3131
|
+
* template. The <code>SourceTemplate</code> ARN can contain any Amazon Web Services account and any
|
|
3132
|
+
* Amazon QuickSight-supported Amazon Web Services Region;. </p>
|
|
3031
3133
|
* <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to
|
|
3032
3134
|
* list the replacement datasets for the placeholders listed in the original. The schema in
|
|
3033
3135
|
* each dataset must match its placeholder. </p>
|
|
@@ -3053,7 +3155,7 @@ export interface UpdateDashboardRequest {
|
|
|
3053
3155
|
* <p>
|
|
3054
3156
|
* <code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This
|
|
3055
3157
|
* status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is
|
|
3056
|
-
* set to <code>DISABLED</code>, QuickSight disables the left filter pane on the
|
|
3158
|
+
* set to <code>DISABLED</code>, Amazon QuickSight disables the left filter pane on the
|
|
3057
3159
|
* published dashboard, which can be used for ad hoc (one-time) filtering. This
|
|
3058
3160
|
* option is <code>ENABLED</code> by default. </p>
|
|
3059
3161
|
* </li>
|
|
@@ -3077,7 +3179,7 @@ export interface UpdateDashboardRequest {
|
|
|
3077
3179
|
/**
|
|
3078
3180
|
* <p>The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If
|
|
3079
3181
|
* you add a value for this field, it overrides the value that was originally associated
|
|
3080
|
-
* with the entity. The theme ARN must exist in the same Amazon Web Services account
|
|
3182
|
+
* with the entity. The theme ARN must exist in the same Amazon Web Services account where you create the
|
|
3081
3183
|
* dashboard.</p>
|
|
3082
3184
|
*/
|
|
3083
3185
|
ThemeArn?: string;
|
|
@@ -3135,7 +3237,7 @@ export namespace UpdateDashboardResponse {
|
|
|
3135
3237
|
|
|
3136
3238
|
export interface UpdateDashboardPermissionsRequest {
|
|
3137
3239
|
/**
|
|
3138
|
-
* <p>The ID of the Amazon Web Services account
|
|
3240
|
+
* <p>The ID of the Amazon Web Services account that contains the dashboard whose permissions you're
|
|
3139
3241
|
* updating.</p>
|
|
3140
3242
|
*/
|
|
3141
3243
|
AwsAccountId: string | undefined;
|
|
@@ -3203,7 +3305,7 @@ export namespace UpdateDashboardPermissionsResponse {
|
|
|
3203
3305
|
|
|
3204
3306
|
export interface UpdateDashboardPublishedVersionRequest {
|
|
3205
3307
|
/**
|
|
3206
|
-
* <p>The ID of the Amazon Web Services account
|
|
3308
|
+
* <p>The ID of the Amazon Web Services account that contains the dashboard that you're
|
|
3207
3309
|
* updating.</p>
|
|
3208
3310
|
*/
|
|
3209
3311
|
AwsAccountId: string | undefined;
|
|
@@ -3261,13 +3363,13 @@ export namespace UpdateDashboardPublishedVersionResponse {
|
|
|
3261
3363
|
|
|
3262
3364
|
export interface UpdateDataSetRequest {
|
|
3263
3365
|
/**
|
|
3264
|
-
* <p>The Amazon Web Services account
|
|
3366
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
3265
3367
|
*/
|
|
3266
3368
|
AwsAccountId: string | undefined;
|
|
3267
3369
|
|
|
3268
3370
|
/**
|
|
3269
3371
|
* <p>The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region; for each
|
|
3270
|
-
* Amazon Web Services account
|
|
3372
|
+
* Amazon Web Services account.</p>
|
|
3271
3373
|
*/
|
|
3272
3374
|
DataSetId: string | undefined;
|
|
3273
3375
|
|
|
@@ -3292,7 +3394,7 @@ export interface UpdateDataSetRequest {
|
|
|
3292
3394
|
ImportMode: DataSetImportMode | string | undefined;
|
|
3293
3395
|
|
|
3294
3396
|
/**
|
|
3295
|
-
* <p>Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.</p>
|
|
3397
|
+
* <p>Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.</p>
|
|
3296
3398
|
*/
|
|
3297
3399
|
ColumnGroups?: ColumnGroup[];
|
|
3298
3400
|
|
|
@@ -3317,6 +3419,11 @@ export interface UpdateDataSetRequest {
|
|
|
3317
3419
|
* </code>.</p>
|
|
3318
3420
|
*/
|
|
3319
3421
|
ColumnLevelPermissionRules?: ColumnLevelPermissionRule[];
|
|
3422
|
+
|
|
3423
|
+
/**
|
|
3424
|
+
* <p>The usage configuration to apply to child datasets that reference this dataset as a source.</p>
|
|
3425
|
+
*/
|
|
3426
|
+
DataSetUsageConfiguration?: DataSetUsageConfiguration;
|
|
3320
3427
|
}
|
|
3321
3428
|
|
|
3322
3429
|
export namespace UpdateDataSetRequest {
|
|
@@ -3358,7 +3465,7 @@ export interface UpdateDataSetResponse {
|
|
|
3358
3465
|
Arn?: string;
|
|
3359
3466
|
|
|
3360
3467
|
/**
|
|
3361
|
-
* <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
|
|
3468
|
+
* <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>
|
|
3362
3469
|
*/
|
|
3363
3470
|
DataSetId?: string;
|
|
3364
3471
|
|
|
@@ -3396,13 +3503,13 @@ export namespace UpdateDataSetResponse {
|
|
|
3396
3503
|
|
|
3397
3504
|
export interface UpdateDataSetPermissionsRequest {
|
|
3398
3505
|
/**
|
|
3399
|
-
* <p>The Amazon Web Services account
|
|
3506
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
3400
3507
|
*/
|
|
3401
3508
|
AwsAccountId: string | undefined;
|
|
3402
3509
|
|
|
3403
3510
|
/**
|
|
3404
3511
|
* <p>The ID for the dataset whose permissions you want to update. This ID is unique per
|
|
3405
|
-
* Amazon Web Services Region; for each Amazon Web Services account
|
|
3512
|
+
* Amazon Web Services Region; for each Amazon Web Services account.</p>
|
|
3406
3513
|
*/
|
|
3407
3514
|
DataSetId: string | undefined;
|
|
3408
3515
|
|
|
@@ -3434,7 +3541,7 @@ export interface UpdateDataSetPermissionsResponse {
|
|
|
3434
3541
|
|
|
3435
3542
|
/**
|
|
3436
3543
|
* <p>The ID for the dataset whose permissions you want to update. This ID is unique per
|
|
3437
|
-
* Amazon Web Services Region; for each Amazon Web Services account
|
|
3544
|
+
* Amazon Web Services Region; for each Amazon Web Services account.</p>
|
|
3438
3545
|
*/
|
|
3439
3546
|
DataSetId?: string;
|
|
3440
3547
|
|
|
@@ -3460,12 +3567,12 @@ export namespace UpdateDataSetPermissionsResponse {
|
|
|
3460
3567
|
|
|
3461
3568
|
export interface UpdateDataSourceRequest {
|
|
3462
3569
|
/**
|
|
3463
|
-
* <p>The Amazon Web Services account
|
|
3570
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
3464
3571
|
*/
|
|
3465
3572
|
AwsAccountId: string | undefined;
|
|
3466
3573
|
|
|
3467
3574
|
/**
|
|
3468
|
-
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
3575
|
+
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account. </p>
|
|
3469
3576
|
*/
|
|
3470
3577
|
DataSourceId: string | undefined;
|
|
3471
3578
|
|
|
@@ -3475,24 +3582,24 @@ export interface UpdateDataSourceRequest {
|
|
|
3475
3582
|
Name: string | undefined;
|
|
3476
3583
|
|
|
3477
3584
|
/**
|
|
3478
|
-
* <p>The parameters that QuickSight uses to connect to your underlying source.</p>
|
|
3585
|
+
* <p>The parameters that Amazon QuickSight uses to connect to your underlying source.</p>
|
|
3479
3586
|
*/
|
|
3480
3587
|
DataSourceParameters?: DataSourceParameters;
|
|
3481
3588
|
|
|
3482
3589
|
/**
|
|
3483
|
-
* <p>The credentials that QuickSight that uses to connect to your underlying source. Currently,
|
|
3590
|
+
* <p>The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently,
|
|
3484
3591
|
* only credentials based on user name and password are supported.</p>
|
|
3485
3592
|
*/
|
|
3486
3593
|
Credentials?: DataSourceCredentials;
|
|
3487
3594
|
|
|
3488
3595
|
/**
|
|
3489
|
-
* <p>Use this parameter only when you want QuickSight to use a VPC connection when connecting to
|
|
3596
|
+
* <p>Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to
|
|
3490
3597
|
* your underlying source.</p>
|
|
3491
3598
|
*/
|
|
3492
3599
|
VpcConnectionProperties?: VpcConnectionProperties;
|
|
3493
3600
|
|
|
3494
3601
|
/**
|
|
3495
|
-
* <p>Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying
|
|
3602
|
+
* <p>Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying
|
|
3496
3603
|
* source.</p>
|
|
3497
3604
|
*/
|
|
3498
3605
|
SslProperties?: SslProperties;
|
|
@@ -3518,7 +3625,7 @@ export interface UpdateDataSourceResponse {
|
|
|
3518
3625
|
Arn?: string;
|
|
3519
3626
|
|
|
3520
3627
|
/**
|
|
3521
|
-
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
3628
|
+
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.</p>
|
|
3522
3629
|
*/
|
|
3523
3630
|
DataSourceId?: string;
|
|
3524
3631
|
|
|
@@ -3549,12 +3656,12 @@ export namespace UpdateDataSourceResponse {
|
|
|
3549
3656
|
|
|
3550
3657
|
export interface UpdateDataSourcePermissionsRequest {
|
|
3551
3658
|
/**
|
|
3552
|
-
* <p>The Amazon Web Services account
|
|
3659
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
3553
3660
|
*/
|
|
3554
3661
|
AwsAccountId: string | undefined;
|
|
3555
3662
|
|
|
3556
3663
|
/**
|
|
3557
|
-
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
3664
|
+
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account. </p>
|
|
3558
3665
|
*/
|
|
3559
3666
|
DataSourceId: string | undefined;
|
|
3560
3667
|
|
|
@@ -3585,7 +3692,7 @@ export interface UpdateDataSourcePermissionsResponse {
|
|
|
3585
3692
|
DataSourceArn?: string;
|
|
3586
3693
|
|
|
3587
3694
|
/**
|
|
3588
|
-
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account
|
|
3695
|
+
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.</p>
|
|
3589
3696
|
*/
|
|
3590
3697
|
DataSourceId?: string;
|
|
3591
3698
|
|
|
@@ -3745,8 +3852,8 @@ export interface UpdateGroupRequest {
|
|
|
3745
3852
|
Description?: string;
|
|
3746
3853
|
|
|
3747
3854
|
/**
|
|
3748
|
-
* <p>The ID for the Amazon Web Services account
|
|
3749
|
-
* Amazon Web Services account
|
|
3855
|
+
* <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
|
|
3856
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
3750
3857
|
*/
|
|
3751
3858
|
AwsAccountId: string | undefined;
|
|
3752
3859
|
|
|
@@ -3793,12 +3900,12 @@ export namespace UpdateGroupResponse {
|
|
|
3793
3900
|
|
|
3794
3901
|
export interface UpdateIAMPolicyAssignmentRequest {
|
|
3795
3902
|
/**
|
|
3796
|
-
* <p>The ID of the Amazon Web Services account
|
|
3903
|
+
* <p>The ID of the Amazon Web Services account that contains the IAMpolicy assignment. </p>
|
|
3797
3904
|
*/
|
|
3798
3905
|
AwsAccountId: string | undefined;
|
|
3799
3906
|
|
|
3800
3907
|
/**
|
|
3801
|
-
* <p>The name of the assignment, also called a rule. This name must be unique within an Amazon Web Services account
|
|
3908
|
+
* <p>The name of the assignment, also called a rule. This name must be unique within an Amazon Web Services account.</p>
|
|
3802
3909
|
*/
|
|
3803
3910
|
AssignmentName: string | undefined;
|
|
3804
3911
|
|
|
@@ -3829,13 +3936,13 @@ export interface UpdateIAMPolicyAssignmentRequest {
|
|
|
3829
3936
|
AssignmentStatus?: AssignmentStatus | string;
|
|
3830
3937
|
|
|
3831
3938
|
/**
|
|
3832
|
-
* <p>The ARN for the
|
|
3939
|
+
* <p>The ARN for the IAMpolicy to apply to the Amazon QuickSight users and groups
|
|
3833
3940
|
* specified in this assignment.</p>
|
|
3834
3941
|
*/
|
|
3835
3942
|
PolicyArn?: string;
|
|
3836
3943
|
|
|
3837
3944
|
/**
|
|
3838
|
-
* <p>The QuickSight users, groups, or both that you want to assign the policy to.</p>
|
|
3945
|
+
* <p>The Amazon QuickSight users, groups, or both that you want to assign the policy to.</p>
|
|
3839
3946
|
*/
|
|
3840
3947
|
Identities?: { [key: string]: string[] };
|
|
3841
3948
|
}
|
|
@@ -3861,13 +3968,13 @@ export interface UpdateIAMPolicyAssignmentResponse {
|
|
|
3861
3968
|
AssignmentId?: string;
|
|
3862
3969
|
|
|
3863
3970
|
/**
|
|
3864
|
-
* <p>The ARN for the
|
|
3971
|
+
* <p>The ARN for the IAMpolicy applied to the Amazon QuickSight users and groups specified in this
|
|
3865
3972
|
* assignment.</p>
|
|
3866
3973
|
*/
|
|
3867
3974
|
PolicyArn?: string;
|
|
3868
3975
|
|
|
3869
3976
|
/**
|
|
3870
|
-
* <p>The QuickSight users, groups, or both that the
|
|
3977
|
+
* <p>The Amazon QuickSight users, groups, or both that the IAMpolicy is assigned to.</p>
|
|
3871
3978
|
*/
|
|
3872
3979
|
Identities?: { [key: string]: string[] };
|
|
3873
3980
|
|
|
@@ -3914,7 +4021,7 @@ export namespace UpdateIAMPolicyAssignmentResponse {
|
|
|
3914
4021
|
|
|
3915
4022
|
export interface UpdateTemplateRequest {
|
|
3916
4023
|
/**
|
|
3917
|
-
* <p>The ID of the Amazon Web Services account
|
|
4024
|
+
* <p>The ID of the Amazon Web Services account that contains the template that you're updating.</p>
|
|
3918
4025
|
*/
|
|
3919
4026
|
AwsAccountId: string | undefined;
|
|
3920
4027
|
|
|
@@ -3930,7 +4037,7 @@ export interface UpdateTemplateRequest {
|
|
|
3930
4037
|
* analysis. Both of these require an Amazon Resource Name (ARN). For
|
|
3931
4038
|
* <code>SourceTemplate</code>, specify the ARN of the source template. For
|
|
3932
4039
|
* <code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code>
|
|
3933
|
-
* ARN can contain any Amazon Web Services account
|
|
4040
|
+
* ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;. </p>
|
|
3934
4041
|
* <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or
|
|
3935
4042
|
* <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed
|
|
3936
4043
|
* in the original. The schema in each dataset must match its placeholder. </p>
|
|
@@ -4003,7 +4110,7 @@ export namespace UpdateTemplateResponse {
|
|
|
4003
4110
|
|
|
4004
4111
|
export interface UpdateTemplateAliasRequest {
|
|
4005
4112
|
/**
|
|
4006
|
-
* <p>The ID of the Amazon Web Services account
|
|
4113
|
+
* <p>The ID of the Amazon Web Services account that contains the template alias that you're updating.</p>
|
|
4007
4114
|
*/
|
|
4008
4115
|
AwsAccountId: string | undefined;
|
|
4009
4116
|
|
|
@@ -4063,7 +4170,7 @@ export namespace UpdateTemplateAliasResponse {
|
|
|
4063
4170
|
|
|
4064
4171
|
export interface UpdateTemplatePermissionsRequest {
|
|
4065
4172
|
/**
|
|
4066
|
-
* <p>The ID of the Amazon Web Services account
|
|
4173
|
+
* <p>The ID of the Amazon Web Services account that contains the template.</p>
|
|
4067
4174
|
*/
|
|
4068
4175
|
AwsAccountId: string | undefined;
|
|
4069
4176
|
|
|
@@ -4130,7 +4237,7 @@ export namespace UpdateTemplatePermissionsResponse {
|
|
|
4130
4237
|
|
|
4131
4238
|
export interface UpdateThemeRequest {
|
|
4132
4239
|
/**
|
|
4133
|
-
* <p>The ID of the Amazon Web Services account
|
|
4240
|
+
* <p>The ID of the Amazon Web Services account that contains the theme that you're updating.</p>
|
|
4134
4241
|
*/
|
|
4135
4242
|
AwsAccountId: string | undefined;
|
|
4136
4243
|
|
|
@@ -4215,7 +4322,7 @@ export namespace UpdateThemeResponse {
|
|
|
4215
4322
|
|
|
4216
4323
|
export interface UpdateThemeAliasRequest {
|
|
4217
4324
|
/**
|
|
4218
|
-
* <p>The ID of the Amazon Web Services account
|
|
4325
|
+
* <p>The ID of the Amazon Web Services account that contains the theme alias that you're updating.</p>
|
|
4219
4326
|
*/
|
|
4220
4327
|
AwsAccountId: string | undefined;
|
|
4221
4328
|
|
|
@@ -4272,7 +4379,7 @@ export namespace UpdateThemeAliasResponse {
|
|
|
4272
4379
|
|
|
4273
4380
|
export interface UpdateThemePermissionsRequest {
|
|
4274
4381
|
/**
|
|
4275
|
-
* <p>The ID of the Amazon Web Services account
|
|
4382
|
+
* <p>The ID of the Amazon Web Services account that contains the theme.</p>
|
|
4276
4383
|
*/
|
|
4277
4384
|
AwsAccountId: string | undefined;
|
|
4278
4385
|
|
|
@@ -4344,8 +4451,8 @@ export interface UpdateUserRequest {
|
|
|
4344
4451
|
UserName: string | undefined;
|
|
4345
4452
|
|
|
4346
4453
|
/**
|
|
4347
|
-
* <p>The ID for the Amazon Web Services account
|
|
4348
|
-
* Amazon Web Services account
|
|
4454
|
+
* <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the
|
|
4455
|
+
* Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
4349
4456
|
*/
|
|
4350
4457
|
AwsAccountId: string | undefined;
|
|
4351
4458
|
|
|
@@ -4378,7 +4485,7 @@ export interface UpdateUserRequest {
|
|
|
4378
4485
|
* settings.</p>
|
|
4379
4486
|
* </li>
|
|
4380
4487
|
* </ul>
|
|
4381
|
-
* <p>The name of the QuickSight role is invisible to the user except for the console
|
|
4488
|
+
* <p>The name of the Amazon QuickSight role is invisible to the user except for the console
|
|
4382
4489
|
* screens dealing with permissions.</p>
|
|
4383
4490
|
*/
|
|
4384
4491
|
Role: UserRole | string | undefined;
|
|
@@ -4402,13 +4509,13 @@ export interface UpdateUserRequest {
|
|
|
4402
4509
|
* </li>
|
|
4403
4510
|
* </ul>
|
|
4404
4511
|
* <p>A set of custom permissions includes any combination of these restrictions. Currently,
|
|
4405
|
-
* you need to create the profile names for custom permission sets by using the QuickSight
|
|
4512
|
+
* you need to create the profile names for custom permission sets by using the Amazon QuickSight
|
|
4406
4513
|
* console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of
|
|
4407
|
-
* permissions to a QuickSight user. </p>
|
|
4408
|
-
* <p>QuickSight custom permissions are applied through
|
|
4409
|
-
* override the permissions typically granted by assigning QuickSight users to one of the
|
|
4410
|
-
* default security cohorts in QuickSight (admin, author, reader).</p>
|
|
4411
|
-
* <p>This feature is available only to QuickSight Enterprise edition subscriptions.</p>
|
|
4514
|
+
* permissions to a Amazon QuickSight user. </p>
|
|
4515
|
+
* <p>Amazon QuickSight custom permissions are applied through IAMpolicies. Therefore, they
|
|
4516
|
+
* override the permissions typically granted by assigning Amazon QuickSight users to one of the
|
|
4517
|
+
* default security cohorts in Amazon QuickSight (admin, author, reader).</p>
|
|
4518
|
+
* <p>This feature is available only to Amazon QuickSight Enterprise edition subscriptions.</p>
|
|
4412
4519
|
*/
|
|
4413
4520
|
CustomPermissionsName?: string;
|
|
4414
4521
|
|
|
@@ -4421,7 +4528,7 @@ export interface UpdateUserRequest {
|
|
|
4421
4528
|
UnapplyCustomPermissions?: boolean;
|
|
4422
4529
|
|
|
4423
4530
|
/**
|
|
4424
|
-
* <p>The type of supported external login provider that provides identity to let a user federate into QuickSight with an associated
|
|
4531
|
+
* <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>
|
|
4425
4532
|
* <ul>
|
|
4426
4533
|
* <li>
|
|
4427
4534
|
* <p>
|
|
@@ -4443,7 +4550,7 @@ export interface UpdateUserRequest {
|
|
|
4443
4550
|
|
|
4444
4551
|
/**
|
|
4445
4552
|
* <p>The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate
|
|
4446
|
-
* into QuickSight with an associated
|
|
4553
|
+
* into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should
|
|
4447
4554
|
* only be used when <code>ExternalLoginFederationProviderType</code> parameter is set to <code>CUSTOM_OIDC</code>.</p>
|
|
4448
4555
|
*/
|
|
4449
4556
|
CustomFederationProviderUrl?: string;
|