@aws-sdk/client-quicksight 3.295.0 → 3.297.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/dist-types/QuickSight.d.ts +127 -0
- package/dist-types/QuickSightClient.d.ts +24 -4
- package/dist-types/commands/CancelIngestionCommand.d.ts +16 -0
- package/dist-types/commands/CreateAccountCustomizationCommand.d.ts +16 -0
- package/dist-types/commands/CreateAccountSubscriptionCommand.d.ts +16 -0
- package/dist-types/commands/CreateAnalysisCommand.d.ts +16 -0
- package/dist-types/commands/CreateDashboardCommand.d.ts +16 -0
- package/dist-types/commands/CreateDataSetCommand.d.ts +16 -0
- package/dist-types/commands/CreateDataSourceCommand.d.ts +16 -0
- package/dist-types/commands/CreateFolderCommand.d.ts +16 -0
- package/dist-types/commands/CreateFolderMembershipCommand.d.ts +16 -0
- package/dist-types/commands/CreateGroupCommand.d.ts +16 -0
- package/dist-types/commands/CreateGroupMembershipCommand.d.ts +16 -0
- package/dist-types/commands/CreateIAMPolicyAssignmentCommand.d.ts +16 -0
- package/dist-types/commands/CreateIngestionCommand.d.ts +16 -0
- package/dist-types/commands/CreateNamespaceCommand.d.ts +16 -0
- package/dist-types/commands/CreateTemplateAliasCommand.d.ts +16 -0
- package/dist-types/commands/CreateTemplateCommand.d.ts +16 -0
- package/dist-types/commands/CreateThemeAliasCommand.d.ts +16 -0
- package/dist-types/commands/CreateThemeCommand.d.ts +16 -0
- package/dist-types/commands/DeleteAccountCustomizationCommand.d.ts +16 -0
- package/dist-types/commands/DeleteAccountSubscriptionCommand.d.ts +16 -0
- package/dist-types/commands/DeleteAnalysisCommand.d.ts +16 -0
- package/dist-types/commands/DeleteDashboardCommand.d.ts +16 -0
- package/dist-types/commands/DeleteDataSetCommand.d.ts +16 -0
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +16 -0
- package/dist-types/commands/DeleteFolderCommand.d.ts +16 -0
- package/dist-types/commands/DeleteFolderMembershipCommand.d.ts +16 -0
- package/dist-types/commands/DeleteGroupCommand.d.ts +16 -0
- package/dist-types/commands/DeleteGroupMembershipCommand.d.ts +16 -0
- package/dist-types/commands/DeleteIAMPolicyAssignmentCommand.d.ts +16 -0
- package/dist-types/commands/DeleteNamespaceCommand.d.ts +16 -0
- package/dist-types/commands/DeleteTemplateAliasCommand.d.ts +16 -0
- package/dist-types/commands/DeleteTemplateCommand.d.ts +16 -0
- package/dist-types/commands/DeleteThemeAliasCommand.d.ts +16 -0
- package/dist-types/commands/DeleteThemeCommand.d.ts +16 -0
- package/dist-types/commands/DeleteUserByPrincipalIdCommand.d.ts +16 -0
- package/dist-types/commands/DeleteUserCommand.d.ts +16 -0
- package/dist-types/commands/DescribeAccountCustomizationCommand.d.ts +16 -0
- package/dist-types/commands/DescribeAccountSettingsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeAccountSubscriptionCommand.d.ts +16 -0
- package/dist-types/commands/DescribeAnalysisCommand.d.ts +16 -0
- package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +16 -0
- package/dist-types/commands/DescribeAnalysisPermissionsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDashboardCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDashboardPermissionsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDataSetCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDataSetPermissionsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDataSourceCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDataSourcePermissionsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeFolderCommand.d.ts +16 -0
- package/dist-types/commands/DescribeFolderPermissionsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeFolderResolvedPermissionsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeGroupCommand.d.ts +16 -0
- package/dist-types/commands/DescribeGroupMembershipCommand.d.ts +16 -0
- package/dist-types/commands/DescribeIAMPolicyAssignmentCommand.d.ts +16 -0
- package/dist-types/commands/DescribeIngestionCommand.d.ts +16 -0
- package/dist-types/commands/DescribeIpRestrictionCommand.d.ts +16 -0
- package/dist-types/commands/DescribeNamespaceCommand.d.ts +16 -0
- package/dist-types/commands/DescribeTemplateAliasCommand.d.ts +16 -0
- package/dist-types/commands/DescribeTemplateCommand.d.ts +16 -0
- package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +16 -0
- package/dist-types/commands/DescribeTemplatePermissionsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeThemeAliasCommand.d.ts +16 -0
- package/dist-types/commands/DescribeThemeCommand.d.ts +16 -0
- package/dist-types/commands/DescribeThemePermissionsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeUserCommand.d.ts +16 -0
- package/dist-types/commands/GenerateEmbedUrlForAnonymousUserCommand.d.ts +16 -0
- package/dist-types/commands/GenerateEmbedUrlForRegisteredUserCommand.d.ts +16 -0
- package/dist-types/commands/GetDashboardEmbedUrlCommand.d.ts +16 -0
- package/dist-types/commands/GetSessionEmbedUrlCommand.d.ts +16 -0
- package/dist-types/commands/ListAnalysesCommand.d.ts +16 -0
- package/dist-types/commands/ListDashboardVersionsCommand.d.ts +16 -0
- package/dist-types/commands/ListDashboardsCommand.d.ts +16 -0
- package/dist-types/commands/ListDataSetsCommand.d.ts +16 -0
- package/dist-types/commands/ListDataSourcesCommand.d.ts +16 -0
- package/dist-types/commands/ListFolderMembersCommand.d.ts +16 -0
- package/dist-types/commands/ListFoldersCommand.d.ts +16 -0
- package/dist-types/commands/ListGroupMembershipsCommand.d.ts +16 -0
- package/dist-types/commands/ListGroupsCommand.d.ts +16 -0
- package/dist-types/commands/ListIAMPolicyAssignmentsCommand.d.ts +16 -0
- package/dist-types/commands/ListIAMPolicyAssignmentsForUserCommand.d.ts +16 -0
- package/dist-types/commands/ListIngestionsCommand.d.ts +16 -0
- package/dist-types/commands/ListNamespacesCommand.d.ts +16 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
- package/dist-types/commands/ListTemplateAliasesCommand.d.ts +16 -0
- package/dist-types/commands/ListTemplateVersionsCommand.d.ts +16 -0
- package/dist-types/commands/ListTemplatesCommand.d.ts +16 -0
- package/dist-types/commands/ListThemeAliasesCommand.d.ts +16 -0
- package/dist-types/commands/ListThemeVersionsCommand.d.ts +16 -0
- package/dist-types/commands/ListThemesCommand.d.ts +16 -0
- package/dist-types/commands/ListUserGroupsCommand.d.ts +16 -0
- package/dist-types/commands/ListUsersCommand.d.ts +16 -0
- package/dist-types/commands/RegisterUserCommand.d.ts +16 -0
- package/dist-types/commands/RestoreAnalysisCommand.d.ts +16 -0
- package/dist-types/commands/SearchAnalysesCommand.d.ts +16 -0
- package/dist-types/commands/SearchDashboardsCommand.d.ts +16 -0
- package/dist-types/commands/SearchDataSetsCommand.d.ts +16 -0
- package/dist-types/commands/SearchDataSourcesCommand.d.ts +16 -0
- package/dist-types/commands/SearchFoldersCommand.d.ts +16 -0
- package/dist-types/commands/SearchGroupsCommand.d.ts +16 -0
- package/dist-types/commands/TagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UpdateAccountCustomizationCommand.d.ts +16 -0
- package/dist-types/commands/UpdateAccountSettingsCommand.d.ts +16 -0
- package/dist-types/commands/UpdateAnalysisCommand.d.ts +16 -0
- package/dist-types/commands/UpdateAnalysisPermissionsCommand.d.ts +16 -0
- package/dist-types/commands/UpdateDashboardCommand.d.ts +16 -0
- package/dist-types/commands/UpdateDashboardPermissionsCommand.d.ts +16 -0
- package/dist-types/commands/UpdateDashboardPublishedVersionCommand.d.ts +16 -0
- package/dist-types/commands/UpdateDataSetCommand.d.ts +16 -0
- package/dist-types/commands/UpdateDataSetPermissionsCommand.d.ts +16 -0
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +16 -0
- package/dist-types/commands/UpdateDataSourcePermissionsCommand.d.ts +16 -0
- package/dist-types/commands/UpdateFolderCommand.d.ts +16 -0
- package/dist-types/commands/UpdateFolderPermissionsCommand.d.ts +16 -0
- package/dist-types/commands/UpdateGroupCommand.d.ts +16 -0
- package/dist-types/commands/UpdateIAMPolicyAssignmentCommand.d.ts +16 -0
- package/dist-types/commands/UpdateIpRestrictionCommand.d.ts +16 -0
- package/dist-types/commands/UpdatePublicSharingSettingsCommand.d.ts +16 -0
- package/dist-types/commands/UpdateTemplateAliasCommand.d.ts +16 -0
- package/dist-types/commands/UpdateTemplateCommand.d.ts +16 -0
- package/dist-types/commands/UpdateTemplatePermissionsCommand.d.ts +16 -0
- package/dist-types/commands/UpdateThemeAliasCommand.d.ts +16 -0
- package/dist-types/commands/UpdateThemeCommand.d.ts +16 -0
- package/dist-types/commands/UpdateThemePermissionsCommand.d.ts +16 -0
- package/dist-types/commands/UpdateUserCommand.d.ts +16 -0
- package/dist-types/models/QuickSightServiceException.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +422 -0
- package/dist-types/models/models_1.d.ts +416 -4
- package/dist-types/models/models_2.d.ts +629 -0
- package/dist-types/models/models_3.d.ts +360 -3
- package/dist-types/pagination/Interfaces.d.ts +3 -0
- package/dist-types/pagination/ListAnalysesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListDashboardVersionsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListDashboardsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListDataSetsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListDataSourcesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListIngestionsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListNamespacesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListTemplateAliasesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListTemplateVersionsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListTemplatesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListThemeVersionsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListThemesPaginator.d.ts +3 -0
- package/dist-types/pagination/SearchAnalysesPaginator.d.ts +3 -0
- package/dist-types/pagination/SearchDashboardsPaginator.d.ts +3 -0
- package/dist-types/pagination/SearchDataSetsPaginator.d.ts +3 -0
- package/dist-types/pagination/SearchDataSourcesPaginator.d.ts +3 -0
- package/package.json +29 -29
|
@@ -3,6 +3,7 @@ import { AccountCustomization, AccountInfo, AccountSettings, AdHocFilteringOptio
|
|
|
3
3
|
import { AnalysisDefinition, AnalysisSourceEntity, AnonymousUserEmbeddingExperienceConfiguration, AssignmentStatus, AthenaParameters, AuroraParameters, AuroraPostgreSqlParameters, AwsIotAnalyticsParameters, BorderStyle, CalculatedColumn, CastColumnTypeOperation, ColumnDataType, ColumnGroup, ColumnGroupSchema, ColumnLevelPermissionRule, ColumnSchema, ColumnTag, ColumnTagName, DashboardVisualId, DataSetReference, ExceptionResourceType, FilterOperator, SheetDefinition, Tag } from "./models_1";
|
|
4
4
|
import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
|
|
5
5
|
/**
|
|
6
|
+
* @public
|
|
6
7
|
* <p>One or more preconditions aren't met.</p>
|
|
7
8
|
*/
|
|
8
9
|
export declare class PreconditionNotMetException extends __BaseException {
|
|
@@ -19,6 +20,7 @@ export declare class PreconditionNotMetException extends __BaseException {
|
|
|
19
20
|
constructor(opts: __ExceptionOptionType<PreconditionNotMetException, __BaseException>);
|
|
20
21
|
}
|
|
21
22
|
/**
|
|
23
|
+
* @public
|
|
22
24
|
* <p>A date-time parameter.</p>
|
|
23
25
|
*/
|
|
24
26
|
export interface DateTimeParameter {
|
|
@@ -32,6 +34,7 @@ export interface DateTimeParameter {
|
|
|
32
34
|
Values: Date[] | undefined;
|
|
33
35
|
}
|
|
34
36
|
/**
|
|
37
|
+
* @public
|
|
35
38
|
* <p>A decimal parameter.</p>
|
|
36
39
|
*/
|
|
37
40
|
export interface DecimalParameter {
|
|
@@ -45,6 +48,7 @@ export interface DecimalParameter {
|
|
|
45
48
|
Values: number[] | undefined;
|
|
46
49
|
}
|
|
47
50
|
/**
|
|
51
|
+
* @public
|
|
48
52
|
* <p>An integer parameter.</p>
|
|
49
53
|
*/
|
|
50
54
|
export interface IntegerParameter {
|
|
@@ -58,6 +62,7 @@ export interface IntegerParameter {
|
|
|
58
62
|
Values: number[] | undefined;
|
|
59
63
|
}
|
|
60
64
|
/**
|
|
65
|
+
* @public
|
|
61
66
|
* <p>A string parameter.</p>
|
|
62
67
|
*/
|
|
63
68
|
export interface StringParameter {
|
|
@@ -71,6 +76,7 @@ export interface StringParameter {
|
|
|
71
76
|
Values: string[] | undefined;
|
|
72
77
|
}
|
|
73
78
|
/**
|
|
79
|
+
* @public
|
|
74
80
|
* <p>A list of Amazon QuickSight parameters and the list's override values.</p>
|
|
75
81
|
*/
|
|
76
82
|
export interface _Parameters {
|
|
@@ -92,6 +98,7 @@ export interface _Parameters {
|
|
|
92
98
|
DateTimeParameters?: DateTimeParameter[];
|
|
93
99
|
}
|
|
94
100
|
/**
|
|
101
|
+
* @public
|
|
95
102
|
* <p>Permission for the resource.</p>
|
|
96
103
|
*/
|
|
97
104
|
export interface ResourcePermission {
|
|
@@ -118,6 +125,9 @@ export interface ResourcePermission {
|
|
|
118
125
|
*/
|
|
119
126
|
Actions: string[] | undefined;
|
|
120
127
|
}
|
|
128
|
+
/**
|
|
129
|
+
* @public
|
|
130
|
+
*/
|
|
121
131
|
export interface CreateAnalysisRequest {
|
|
122
132
|
/**
|
|
123
133
|
* <p>The ID of the Amazon Web Services account where you are creating an analysis.</p>
|
|
@@ -171,6 +181,9 @@ export interface CreateAnalysisRequest {
|
|
|
171
181
|
*/
|
|
172
182
|
Definition?: AnalysisDefinition;
|
|
173
183
|
}
|
|
184
|
+
/**
|
|
185
|
+
* @public
|
|
186
|
+
*/
|
|
174
187
|
export interface CreateAnalysisResponse {
|
|
175
188
|
/**
|
|
176
189
|
* <p>The ARN for the analysis.</p>
|
|
@@ -194,6 +207,7 @@ export interface CreateAnalysisResponse {
|
|
|
194
207
|
RequestId?: string;
|
|
195
208
|
}
|
|
196
209
|
/**
|
|
210
|
+
* @public
|
|
197
211
|
* <p>A limit is exceeded.</p>
|
|
198
212
|
*/
|
|
199
213
|
export declare class LimitExceededException extends __BaseException {
|
|
@@ -214,6 +228,7 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
214
228
|
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
215
229
|
}
|
|
216
230
|
/**
|
|
231
|
+
* @public
|
|
217
232
|
* <p>This error indicates that you are calling an operation on an Amazon QuickSight
|
|
218
233
|
* subscription where the edition doesn't include support for that operation. Amazon
|
|
219
234
|
* Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
|
|
@@ -233,6 +248,7 @@ export declare class UnsupportedUserEditionException extends __BaseException {
|
|
|
233
248
|
constructor(opts: __ExceptionOptionType<UnsupportedUserEditionException, __BaseException>);
|
|
234
249
|
}
|
|
235
250
|
/**
|
|
251
|
+
* @public
|
|
236
252
|
* <p>A transform operation that creates calculated columns. Columns created in one such
|
|
237
253
|
* operation form a lexical closure.</p>
|
|
238
254
|
*/
|
|
@@ -243,6 +259,7 @@ export interface CreateColumnsOperation {
|
|
|
243
259
|
Columns: CalculatedColumn[] | undefined;
|
|
244
260
|
}
|
|
245
261
|
/**
|
|
262
|
+
* @public
|
|
246
263
|
* <p>The drill down options for data points in a dashbaord.</p>
|
|
247
264
|
*/
|
|
248
265
|
export interface DataPointDrillUpDownOption {
|
|
@@ -252,6 +269,7 @@ export interface DataPointDrillUpDownOption {
|
|
|
252
269
|
AvailabilityStatus?: DashboardBehavior | string;
|
|
253
270
|
}
|
|
254
271
|
/**
|
|
272
|
+
* @public
|
|
255
273
|
* <p>The data point menu options of a dashboard.</p>
|
|
256
274
|
*/
|
|
257
275
|
export interface DataPointMenuLabelOption {
|
|
@@ -261,6 +279,7 @@ export interface DataPointMenuLabelOption {
|
|
|
261
279
|
AvailabilityStatus?: DashboardBehavior | string;
|
|
262
280
|
}
|
|
263
281
|
/**
|
|
282
|
+
* @public
|
|
264
283
|
* <p>The data point tooltip options.</p>
|
|
265
284
|
*/
|
|
266
285
|
export interface DataPointTooltipOption {
|
|
@@ -270,6 +289,7 @@ export interface DataPointTooltipOption {
|
|
|
270
289
|
AvailabilityStatus?: DashboardBehavior | string;
|
|
271
290
|
}
|
|
272
291
|
/**
|
|
292
|
+
* @public
|
|
273
293
|
* <p>Export to .csv option.</p>
|
|
274
294
|
*/
|
|
275
295
|
export interface ExportToCSVOption {
|
|
@@ -279,6 +299,7 @@ export interface ExportToCSVOption {
|
|
|
279
299
|
AvailabilityStatus?: DashboardBehavior | string;
|
|
280
300
|
}
|
|
281
301
|
/**
|
|
302
|
+
* @public
|
|
282
303
|
* <p>Determines whether or not hidden fields are visible on exported dashbaords.</p>
|
|
283
304
|
*/
|
|
284
305
|
export interface ExportWithHiddenFieldsOption {
|
|
@@ -287,11 +308,15 @@ export interface ExportWithHiddenFieldsOption {
|
|
|
287
308
|
*/
|
|
288
309
|
AvailabilityStatus?: DashboardBehavior | string;
|
|
289
310
|
}
|
|
311
|
+
/**
|
|
312
|
+
* @public
|
|
313
|
+
*/
|
|
290
314
|
export declare enum DashboardUIState {
|
|
291
315
|
COLLAPSED = "COLLAPSED",
|
|
292
316
|
EXPANDED = "EXPANDED"
|
|
293
317
|
}
|
|
294
318
|
/**
|
|
319
|
+
* @public
|
|
295
320
|
* <p>Sheet controls option.</p>
|
|
296
321
|
*/
|
|
297
322
|
export interface SheetControlsOption {
|
|
@@ -301,6 +326,7 @@ export interface SheetControlsOption {
|
|
|
301
326
|
VisibilityState?: DashboardUIState | string;
|
|
302
327
|
}
|
|
303
328
|
/**
|
|
329
|
+
* @public
|
|
304
330
|
* <p>The sheet layout maximization options of a dashbaord.</p>
|
|
305
331
|
*/
|
|
306
332
|
export interface SheetLayoutElementMaximizationOption {
|
|
@@ -310,6 +336,7 @@ export interface SheetLayoutElementMaximizationOption {
|
|
|
310
336
|
AvailabilityStatus?: DashboardBehavior | string;
|
|
311
337
|
}
|
|
312
338
|
/**
|
|
339
|
+
* @public
|
|
313
340
|
* <p>The axis sort options for a visual.</p>
|
|
314
341
|
*/
|
|
315
342
|
export interface VisualAxisSortOption {
|
|
@@ -319,6 +346,7 @@ export interface VisualAxisSortOption {
|
|
|
319
346
|
AvailabilityStatus?: DashboardBehavior | string;
|
|
320
347
|
}
|
|
321
348
|
/**
|
|
349
|
+
* @public
|
|
322
350
|
* <p>The menu options for a visual.</p>
|
|
323
351
|
*/
|
|
324
352
|
export interface VisualMenuOption {
|
|
@@ -328,6 +356,7 @@ export interface VisualMenuOption {
|
|
|
328
356
|
AvailabilityStatus?: DashboardBehavior | string;
|
|
329
357
|
}
|
|
330
358
|
/**
|
|
359
|
+
* @public
|
|
331
360
|
* <p>Determines if hidden fields are included in an exported dashboard.</p>
|
|
332
361
|
*/
|
|
333
362
|
export interface ExportHiddenFieldsOption {
|
|
@@ -337,6 +366,7 @@ export interface ExportHiddenFieldsOption {
|
|
|
337
366
|
AvailabilityStatus?: DashboardBehavior | string;
|
|
338
367
|
}
|
|
339
368
|
/**
|
|
369
|
+
* @public
|
|
340
370
|
* <p>The visual publish options of a visual in a dashboard</p>
|
|
341
371
|
*/
|
|
342
372
|
export interface DashboardVisualPublishOptions {
|
|
@@ -346,6 +376,7 @@ export interface DashboardVisualPublishOptions {
|
|
|
346
376
|
ExportHiddenFieldsOption?: ExportHiddenFieldsOption;
|
|
347
377
|
}
|
|
348
378
|
/**
|
|
379
|
+
* @public
|
|
349
380
|
* <p>Dashboard publish options.</p>
|
|
350
381
|
*/
|
|
351
382
|
export interface DashboardPublishOptions {
|
|
@@ -397,6 +428,7 @@ export interface DashboardPublishOptions {
|
|
|
397
428
|
DataPointTooltipOption?: DataPointTooltipOption;
|
|
398
429
|
}
|
|
399
430
|
/**
|
|
431
|
+
* @public
|
|
400
432
|
* <p>The contents of a dashboard.</p>
|
|
401
433
|
*/
|
|
402
434
|
export interface DashboardVersionDefinition {
|
|
@@ -435,6 +467,7 @@ export interface DashboardVersionDefinition {
|
|
|
435
467
|
AnalysisDefaults?: AnalysisDefaults;
|
|
436
468
|
}
|
|
437
469
|
/**
|
|
470
|
+
* @public
|
|
438
471
|
* <p>Dashboard source template.</p>
|
|
439
472
|
*/
|
|
440
473
|
export interface DashboardSourceTemplate {
|
|
@@ -448,6 +481,7 @@ export interface DashboardSourceTemplate {
|
|
|
448
481
|
Arn: string | undefined;
|
|
449
482
|
}
|
|
450
483
|
/**
|
|
484
|
+
* @public
|
|
451
485
|
* <p>Dashboard source entity.</p>
|
|
452
486
|
*/
|
|
453
487
|
export interface DashboardSourceEntity {
|
|
@@ -456,6 +490,9 @@ export interface DashboardSourceEntity {
|
|
|
456
490
|
*/
|
|
457
491
|
SourceTemplate?: DashboardSourceTemplate;
|
|
458
492
|
}
|
|
493
|
+
/**
|
|
494
|
+
* @public
|
|
495
|
+
*/
|
|
459
496
|
export interface CreateDashboardRequest {
|
|
460
497
|
/**
|
|
461
498
|
* <p>The ID of the Amazon Web Services account where you want to create the dashboard.</p>
|
|
@@ -552,6 +589,9 @@ export interface CreateDashboardRequest {
|
|
|
552
589
|
*/
|
|
553
590
|
Definition?: DashboardVersionDefinition;
|
|
554
591
|
}
|
|
592
|
+
/**
|
|
593
|
+
* @public
|
|
594
|
+
*/
|
|
555
595
|
export interface CreateDashboardResponse {
|
|
556
596
|
/**
|
|
557
597
|
* <p>The ARN of the dashboard.</p>
|
|
@@ -580,6 +620,7 @@ export interface CreateDashboardResponse {
|
|
|
580
620
|
RequestId?: string;
|
|
581
621
|
}
|
|
582
622
|
/**
|
|
623
|
+
* @public
|
|
583
624
|
* <p>The usage configuration to apply to child datasets that reference this dataset as a source.</p>
|
|
584
625
|
*/
|
|
585
626
|
export interface DataSetUsageConfiguration {
|
|
@@ -593,6 +634,7 @@ export interface DataSetUsageConfiguration {
|
|
|
593
634
|
DisableUseAsImportedSource?: boolean;
|
|
594
635
|
}
|
|
595
636
|
/**
|
|
637
|
+
* @public
|
|
596
638
|
* <p>A FieldFolder element is a folder that contains fields and nested subfolders.</p>
|
|
597
639
|
*/
|
|
598
640
|
export interface FieldFolder {
|
|
@@ -605,11 +647,15 @@ export interface FieldFolder {
|
|
|
605
647
|
*/
|
|
606
648
|
columns?: string[];
|
|
607
649
|
}
|
|
650
|
+
/**
|
|
651
|
+
* @public
|
|
652
|
+
*/
|
|
608
653
|
export declare enum DataSetImportMode {
|
|
609
654
|
DIRECT_QUERY = "DIRECT_QUERY",
|
|
610
655
|
SPICE = "SPICE"
|
|
611
656
|
}
|
|
612
657
|
/**
|
|
658
|
+
* @public
|
|
613
659
|
* <p>A transform operation that filters rows based on a condition.</p>
|
|
614
660
|
*/
|
|
615
661
|
export interface FilterOperation {
|
|
@@ -620,6 +666,7 @@ export interface FilterOperation {
|
|
|
620
666
|
ConditionExpression: string | undefined;
|
|
621
667
|
}
|
|
622
668
|
/**
|
|
669
|
+
* @public
|
|
623
670
|
* <p>A transform operation that projects columns. Operations that come after a projection
|
|
624
671
|
* can only refer to projected columns.</p>
|
|
625
672
|
*/
|
|
@@ -630,6 +677,7 @@ export interface ProjectOperation {
|
|
|
630
677
|
ProjectedColumns: string[] | undefined;
|
|
631
678
|
}
|
|
632
679
|
/**
|
|
680
|
+
* @public
|
|
633
681
|
* <p>A transform operation that renames a column.</p>
|
|
634
682
|
*/
|
|
635
683
|
export interface RenameColumnOperation {
|
|
@@ -643,6 +691,7 @@ export interface RenameColumnOperation {
|
|
|
643
691
|
NewColumnName: string | undefined;
|
|
644
692
|
}
|
|
645
693
|
/**
|
|
694
|
+
* @public
|
|
646
695
|
* <p>A transform operation that tags a column with additional information.</p>
|
|
647
696
|
*/
|
|
648
697
|
export interface TagColumnOperation {
|
|
@@ -659,6 +708,7 @@ export interface TagColumnOperation {
|
|
|
659
708
|
Tags: ColumnTag[] | undefined;
|
|
660
709
|
}
|
|
661
710
|
/**
|
|
711
|
+
* @public
|
|
662
712
|
* <p>A transform operation that removes tags associated with a column.</p>
|
|
663
713
|
*/
|
|
664
714
|
export interface UntagColumnOperation {
|
|
@@ -672,10 +722,14 @@ export interface UntagColumnOperation {
|
|
|
672
722
|
TagNames: (ColumnTagName | string)[] | undefined;
|
|
673
723
|
}
|
|
674
724
|
/**
|
|
725
|
+
* @public
|
|
675
726
|
* <p>A data transformation on a logical table. This is a variant type structure. For this
|
|
676
727
|
* structure to be valid, only one of the attributes can be non-null.</p>
|
|
677
728
|
*/
|
|
678
729
|
export type TransformOperation = TransformOperation.CastColumnTypeOperationMember | TransformOperation.CreateColumnsOperationMember | TransformOperation.FilterOperationMember | TransformOperation.ProjectOperationMember | TransformOperation.RenameColumnOperationMember | TransformOperation.TagColumnOperationMember | TransformOperation.UntagColumnOperationMember | TransformOperation.$UnknownMember;
|
|
730
|
+
/**
|
|
731
|
+
* @public
|
|
732
|
+
*/
|
|
679
733
|
export declare namespace TransformOperation {
|
|
680
734
|
/**
|
|
681
735
|
* <p>An operation that projects columns. Operations that come after a projection can only
|
|
@@ -793,6 +847,7 @@ export declare namespace TransformOperation {
|
|
|
793
847
|
const visit: <T>(value: TransformOperation, visitor: Visitor<T>) => T;
|
|
794
848
|
}
|
|
795
849
|
/**
|
|
850
|
+
* @public
|
|
796
851
|
* <p>Properties associated with the columns participating in a join.</p>
|
|
797
852
|
*/
|
|
798
853
|
export interface JoinKeyProperties {
|
|
@@ -802,6 +857,9 @@ export interface JoinKeyProperties {
|
|
|
802
857
|
*/
|
|
803
858
|
UniqueKey?: boolean;
|
|
804
859
|
}
|
|
860
|
+
/**
|
|
861
|
+
* @public
|
|
862
|
+
*/
|
|
805
863
|
export declare enum JoinType {
|
|
806
864
|
INNER = "INNER",
|
|
807
865
|
LEFT = "LEFT",
|
|
@@ -809,6 +867,7 @@ export declare enum JoinType {
|
|
|
809
867
|
RIGHT = "RIGHT"
|
|
810
868
|
}
|
|
811
869
|
/**
|
|
870
|
+
* @public
|
|
812
871
|
* <p>The instructions associated with a join. </p>
|
|
813
872
|
*/
|
|
814
873
|
export interface JoinInstruction {
|
|
@@ -838,6 +897,7 @@ export interface JoinInstruction {
|
|
|
838
897
|
OnClause: string | undefined;
|
|
839
898
|
}
|
|
840
899
|
/**
|
|
900
|
+
* @public
|
|
841
901
|
* <p>Information about the source of a logical table. This is a variant type structure. For
|
|
842
902
|
* this structure to be valid, only one of the attributes can be non-null.</p>
|
|
843
903
|
*/
|
|
@@ -856,6 +916,7 @@ export interface LogicalTableSource {
|
|
|
856
916
|
DataSetArn?: string;
|
|
857
917
|
}
|
|
858
918
|
/**
|
|
919
|
+
* @public
|
|
859
920
|
* <p>A <i>logical table</i> is a unit that joins and that data
|
|
860
921
|
* transformations operate on. A logical table has a source, which can be either a physical
|
|
861
922
|
* table or result of a join. When a logical table points to a physical table, the logical
|
|
@@ -875,6 +936,9 @@ export interface LogicalTable {
|
|
|
875
936
|
*/
|
|
876
937
|
Source: LogicalTableSource | undefined;
|
|
877
938
|
}
|
|
939
|
+
/**
|
|
940
|
+
* @public
|
|
941
|
+
*/
|
|
878
942
|
export declare enum InputColumnDataType {
|
|
879
943
|
BIT = "BIT",
|
|
880
944
|
BOOLEAN = "BOOLEAN",
|
|
@@ -885,6 +949,7 @@ export declare enum InputColumnDataType {
|
|
|
885
949
|
STRING = "STRING"
|
|
886
950
|
}
|
|
887
951
|
/**
|
|
952
|
+
* @public
|
|
888
953
|
* <p>Metadata for a column that is used as the input of a transform operation.</p>
|
|
889
954
|
*/
|
|
890
955
|
export interface InputColumn {
|
|
@@ -898,6 +963,7 @@ export interface InputColumn {
|
|
|
898
963
|
Type: InputColumnDataType | string | undefined;
|
|
899
964
|
}
|
|
900
965
|
/**
|
|
966
|
+
* @public
|
|
901
967
|
* <p>A physical table type built from the results of the custom SQL query.</p>
|
|
902
968
|
*/
|
|
903
969
|
export interface CustomSql {
|
|
@@ -919,6 +985,7 @@ export interface CustomSql {
|
|
|
919
985
|
Columns?: InputColumn[];
|
|
920
986
|
}
|
|
921
987
|
/**
|
|
988
|
+
* @public
|
|
922
989
|
* <p>A physical table type for relational data sources.</p>
|
|
923
990
|
*/
|
|
924
991
|
export interface RelationalTable {
|
|
@@ -943,6 +1010,9 @@ export interface RelationalTable {
|
|
|
943
1010
|
*/
|
|
944
1011
|
InputColumns: InputColumn[] | undefined;
|
|
945
1012
|
}
|
|
1013
|
+
/**
|
|
1014
|
+
* @public
|
|
1015
|
+
*/
|
|
946
1016
|
export declare enum FileFormat {
|
|
947
1017
|
CLF = "CLF",
|
|
948
1018
|
CSV = "CSV",
|
|
@@ -951,11 +1021,15 @@ export declare enum FileFormat {
|
|
|
951
1021
|
TSV = "TSV",
|
|
952
1022
|
XLSX = "XLSX"
|
|
953
1023
|
}
|
|
1024
|
+
/**
|
|
1025
|
+
* @public
|
|
1026
|
+
*/
|
|
954
1027
|
export declare enum TextQualifier {
|
|
955
1028
|
DOUBLE_QUOTE = "DOUBLE_QUOTE",
|
|
956
1029
|
SINGLE_QUOTE = "SINGLE_QUOTE"
|
|
957
1030
|
}
|
|
958
1031
|
/**
|
|
1032
|
+
* @public
|
|
959
1033
|
* <p>Information about the format for a source file or files.</p>
|
|
960
1034
|
*/
|
|
961
1035
|
export interface UploadSettings {
|
|
@@ -981,6 +1055,7 @@ export interface UploadSettings {
|
|
|
981
1055
|
Delimiter?: string;
|
|
982
1056
|
}
|
|
983
1057
|
/**
|
|
1058
|
+
* @public
|
|
984
1059
|
* <p>A physical table type for an S3 data source.</p>
|
|
985
1060
|
*/
|
|
986
1061
|
export interface S3Source {
|
|
@@ -1001,11 +1076,15 @@ export interface S3Source {
|
|
|
1001
1076
|
InputColumns: InputColumn[] | undefined;
|
|
1002
1077
|
}
|
|
1003
1078
|
/**
|
|
1079
|
+
* @public
|
|
1004
1080
|
* <p>A view of a data source that contains information about the shape of the data in the
|
|
1005
1081
|
* underlying source. This is a variant type structure. For this structure to be valid,
|
|
1006
1082
|
* only one of the attributes can be non-null.</p>
|
|
1007
1083
|
*/
|
|
1008
1084
|
export type PhysicalTable = PhysicalTable.CustomSqlMember | PhysicalTable.RelationalTableMember | PhysicalTable.S3SourceMember | PhysicalTable.$UnknownMember;
|
|
1085
|
+
/**
|
|
1086
|
+
* @public
|
|
1087
|
+
*/
|
|
1009
1088
|
export declare namespace PhysicalTable {
|
|
1010
1089
|
/**
|
|
1011
1090
|
* <p>A physical table type for relational data sources.</p>
|
|
@@ -1048,19 +1127,29 @@ export declare namespace PhysicalTable {
|
|
|
1048
1127
|
}
|
|
1049
1128
|
const visit: <T>(value: PhysicalTable, visitor: Visitor<T>) => T;
|
|
1050
1129
|
}
|
|
1130
|
+
/**
|
|
1131
|
+
* @public
|
|
1132
|
+
*/
|
|
1051
1133
|
export declare enum RowLevelPermissionFormatVersion {
|
|
1052
1134
|
VERSION_1 = "VERSION_1",
|
|
1053
1135
|
VERSION_2 = "VERSION_2"
|
|
1054
1136
|
}
|
|
1137
|
+
/**
|
|
1138
|
+
* @public
|
|
1139
|
+
*/
|
|
1055
1140
|
export declare enum RowLevelPermissionPolicy {
|
|
1056
1141
|
DENY_ACCESS = "DENY_ACCESS",
|
|
1057
1142
|
GRANT_ACCESS = "GRANT_ACCESS"
|
|
1058
1143
|
}
|
|
1144
|
+
/**
|
|
1145
|
+
* @public
|
|
1146
|
+
*/
|
|
1059
1147
|
export declare enum Status {
|
|
1060
1148
|
DISABLED = "DISABLED",
|
|
1061
1149
|
ENABLED = "ENABLED"
|
|
1062
1150
|
}
|
|
1063
1151
|
/**
|
|
1152
|
+
* @public
|
|
1064
1153
|
* <p>Information about a dataset that contains permissions for row-level security (RLS).
|
|
1065
1154
|
* The permissions dataset maps fields to users or groups. For more information, see
|
|
1066
1155
|
* <a href="https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html">Using Row-Level Security (RLS) to Restrict Access to a Dataset</a> in the <i>Amazon QuickSight User
|
|
@@ -1093,6 +1182,7 @@ export interface RowLevelPermissionDataSet {
|
|
|
1093
1182
|
Status?: Status | string;
|
|
1094
1183
|
}
|
|
1095
1184
|
/**
|
|
1185
|
+
* @public
|
|
1096
1186
|
* <p>A set of rules associated with a tag.</p>
|
|
1097
1187
|
*/
|
|
1098
1188
|
export interface RowLevelPermissionTagRule {
|
|
@@ -1114,6 +1204,7 @@ export interface RowLevelPermissionTagRule {
|
|
|
1114
1204
|
MatchAllValue?: string;
|
|
1115
1205
|
}
|
|
1116
1206
|
/**
|
|
1207
|
+
* @public
|
|
1117
1208
|
* <p>The configuration of tags on a dataset to set row-level security. </p>
|
|
1118
1209
|
*/
|
|
1119
1210
|
export interface RowLevelPermissionTagConfiguration {
|
|
@@ -1126,6 +1217,9 @@ export interface RowLevelPermissionTagConfiguration {
|
|
|
1126
1217
|
*/
|
|
1127
1218
|
TagRules: RowLevelPermissionTagRule[] | undefined;
|
|
1128
1219
|
}
|
|
1220
|
+
/**
|
|
1221
|
+
* @public
|
|
1222
|
+
*/
|
|
1129
1223
|
export interface CreateDataSetRequest {
|
|
1130
1224
|
/**
|
|
1131
1225
|
* <p>The Amazon Web Services account ID.</p>
|
|
@@ -1186,6 +1280,9 @@ export interface CreateDataSetRequest {
|
|
|
1186
1280
|
*/
|
|
1187
1281
|
DataSetUsageConfiguration?: DataSetUsageConfiguration;
|
|
1188
1282
|
}
|
|
1283
|
+
/**
|
|
1284
|
+
* @public
|
|
1285
|
+
*/
|
|
1189
1286
|
export interface CreateDataSetResponse {
|
|
1190
1287
|
/**
|
|
1191
1288
|
* <p>The Amazon Resource Name (ARN) of the dataset.</p>
|
|
@@ -1215,6 +1312,7 @@ export interface CreateDataSetResponse {
|
|
|
1215
1312
|
Status?: number;
|
|
1216
1313
|
}
|
|
1217
1314
|
/**
|
|
1315
|
+
* @public
|
|
1218
1316
|
* <p>The required parameters that are needed to connect to a Databricks data source.</p>
|
|
1219
1317
|
*/
|
|
1220
1318
|
export interface DatabricksParameters {
|
|
@@ -1232,6 +1330,7 @@ export interface DatabricksParameters {
|
|
|
1232
1330
|
SqlEndpointPath: string | undefined;
|
|
1233
1331
|
}
|
|
1234
1332
|
/**
|
|
1333
|
+
* @public
|
|
1235
1334
|
* <p>The required parameters for connecting to an Exasol data source.</p>
|
|
1236
1335
|
*/
|
|
1237
1336
|
export interface ExasolParameters {
|
|
@@ -1245,6 +1344,7 @@ export interface ExasolParameters {
|
|
|
1245
1344
|
Port: number | undefined;
|
|
1246
1345
|
}
|
|
1247
1346
|
/**
|
|
1347
|
+
* @public
|
|
1248
1348
|
* <p>The parameters for Jira.</p>
|
|
1249
1349
|
*/
|
|
1250
1350
|
export interface JiraParameters {
|
|
@@ -1254,6 +1354,7 @@ export interface JiraParameters {
|
|
|
1254
1354
|
SiteBaseUrl: string | undefined;
|
|
1255
1355
|
}
|
|
1256
1356
|
/**
|
|
1357
|
+
* @public
|
|
1257
1358
|
* <p>The parameters for MariaDB.</p>
|
|
1258
1359
|
*/
|
|
1259
1360
|
export interface MariaDbParameters {
|
|
@@ -1271,6 +1372,7 @@ export interface MariaDbParameters {
|
|
|
1271
1372
|
Database: string | undefined;
|
|
1272
1373
|
}
|
|
1273
1374
|
/**
|
|
1375
|
+
* @public
|
|
1274
1376
|
* <p>The parameters for MySQL.</p>
|
|
1275
1377
|
*/
|
|
1276
1378
|
export interface MySqlParameters {
|
|
@@ -1288,6 +1390,7 @@ export interface MySqlParameters {
|
|
|
1288
1390
|
Database: string | undefined;
|
|
1289
1391
|
}
|
|
1290
1392
|
/**
|
|
1393
|
+
* @public
|
|
1291
1394
|
* <p>The parameters for Oracle.</p>
|
|
1292
1395
|
*/
|
|
1293
1396
|
export interface OracleParameters {
|
|
@@ -1305,6 +1408,7 @@ export interface OracleParameters {
|
|
|
1305
1408
|
Database: string | undefined;
|
|
1306
1409
|
}
|
|
1307
1410
|
/**
|
|
1411
|
+
* @public
|
|
1308
1412
|
* <p>The parameters for PostgreSQL.</p>
|
|
1309
1413
|
*/
|
|
1310
1414
|
export interface PostgreSqlParameters {
|
|
@@ -1322,6 +1426,7 @@ export interface PostgreSqlParameters {
|
|
|
1322
1426
|
Database: string | undefined;
|
|
1323
1427
|
}
|
|
1324
1428
|
/**
|
|
1429
|
+
* @public
|
|
1325
1430
|
* <p>The parameters for Presto.</p>
|
|
1326
1431
|
*/
|
|
1327
1432
|
export interface PrestoParameters {
|
|
@@ -1339,6 +1444,7 @@ export interface PrestoParameters {
|
|
|
1339
1444
|
Catalog: string | undefined;
|
|
1340
1445
|
}
|
|
1341
1446
|
/**
|
|
1447
|
+
* @public
|
|
1342
1448
|
* <p>The parameters for Amazon RDS.</p>
|
|
1343
1449
|
*/
|
|
1344
1450
|
export interface RdsParameters {
|
|
@@ -1352,6 +1458,7 @@ export interface RdsParameters {
|
|
|
1352
1458
|
Database: string | undefined;
|
|
1353
1459
|
}
|
|
1354
1460
|
/**
|
|
1461
|
+
* @public
|
|
1355
1462
|
* <p>The parameters for Amazon Redshift. The <code>ClusterId</code> field can be blank if
|
|
1356
1463
|
* <code>Host</code> and <code>Port</code> are both set. The <code>Host</code> and
|
|
1357
1464
|
* <code>Port</code> fields can be blank if the <code>ClusterId</code> field is set.</p>
|
|
@@ -1376,6 +1483,7 @@ export interface RedshiftParameters {
|
|
|
1376
1483
|
ClusterId?: string;
|
|
1377
1484
|
}
|
|
1378
1485
|
/**
|
|
1486
|
+
* @public
|
|
1379
1487
|
* <p>Amazon S3 manifest file location.</p>
|
|
1380
1488
|
*/
|
|
1381
1489
|
export interface ManifestFileLocation {
|
|
@@ -1389,6 +1497,7 @@ export interface ManifestFileLocation {
|
|
|
1389
1497
|
Key: string | undefined;
|
|
1390
1498
|
}
|
|
1391
1499
|
/**
|
|
1500
|
+
* @public
|
|
1392
1501
|
* <p>The parameters for S3.</p>
|
|
1393
1502
|
*/
|
|
1394
1503
|
export interface S3Parameters {
|
|
@@ -1403,6 +1512,7 @@ export interface S3Parameters {
|
|
|
1403
1512
|
RoleArn?: string;
|
|
1404
1513
|
}
|
|
1405
1514
|
/**
|
|
1515
|
+
* @public
|
|
1406
1516
|
* <p>The parameters for ServiceNow.</p>
|
|
1407
1517
|
*/
|
|
1408
1518
|
export interface ServiceNowParameters {
|
|
@@ -1412,6 +1522,7 @@ export interface ServiceNowParameters {
|
|
|
1412
1522
|
SiteBaseUrl: string | undefined;
|
|
1413
1523
|
}
|
|
1414
1524
|
/**
|
|
1525
|
+
* @public
|
|
1415
1526
|
* <p>The parameters for Snowflake.</p>
|
|
1416
1527
|
*/
|
|
1417
1528
|
export interface SnowflakeParameters {
|
|
@@ -1429,6 +1540,7 @@ export interface SnowflakeParameters {
|
|
|
1429
1540
|
Warehouse: string | undefined;
|
|
1430
1541
|
}
|
|
1431
1542
|
/**
|
|
1543
|
+
* @public
|
|
1432
1544
|
* <p>The parameters for Spark.</p>
|
|
1433
1545
|
*/
|
|
1434
1546
|
export interface SparkParameters {
|
|
@@ -1442,6 +1554,7 @@ export interface SparkParameters {
|
|
|
1442
1554
|
Port: number | undefined;
|
|
1443
1555
|
}
|
|
1444
1556
|
/**
|
|
1557
|
+
* @public
|
|
1445
1558
|
* <p>The parameters for SQL Server.</p>
|
|
1446
1559
|
*/
|
|
1447
1560
|
export interface SqlServerParameters {
|
|
@@ -1459,6 +1572,7 @@ export interface SqlServerParameters {
|
|
|
1459
1572
|
Database: string | undefined;
|
|
1460
1573
|
}
|
|
1461
1574
|
/**
|
|
1575
|
+
* @public
|
|
1462
1576
|
* <p>The parameters for Teradata.</p>
|
|
1463
1577
|
*/
|
|
1464
1578
|
export interface TeradataParameters {
|
|
@@ -1476,6 +1590,7 @@ export interface TeradataParameters {
|
|
|
1476
1590
|
Database: string | undefined;
|
|
1477
1591
|
}
|
|
1478
1592
|
/**
|
|
1593
|
+
* @public
|
|
1479
1594
|
* <p>The parameters for Twitter.</p>
|
|
1480
1595
|
*/
|
|
1481
1596
|
export interface TwitterParameters {
|
|
@@ -1489,11 +1604,15 @@ export interface TwitterParameters {
|
|
|
1489
1604
|
MaxRows: number | undefined;
|
|
1490
1605
|
}
|
|
1491
1606
|
/**
|
|
1607
|
+
* @public
|
|
1492
1608
|
* <p>The parameters that Amazon QuickSight uses to connect to your underlying data source.
|
|
1493
1609
|
* This is a variant type structure. For this structure to be valid, only one of the
|
|
1494
1610
|
* attributes can be non-null.</p>
|
|
1495
1611
|
*/
|
|
1496
1612
|
export type DataSourceParameters = DataSourceParameters.AmazonElasticsearchParametersMember | DataSourceParameters.AmazonOpenSearchParametersMember | DataSourceParameters.AthenaParametersMember | DataSourceParameters.AuroraParametersMember | DataSourceParameters.AuroraPostgreSqlParametersMember | DataSourceParameters.AwsIotAnalyticsParametersMember | DataSourceParameters.DatabricksParametersMember | DataSourceParameters.ExasolParametersMember | DataSourceParameters.JiraParametersMember | DataSourceParameters.MariaDbParametersMember | DataSourceParameters.MySqlParametersMember | DataSourceParameters.OracleParametersMember | DataSourceParameters.PostgreSqlParametersMember | DataSourceParameters.PrestoParametersMember | DataSourceParameters.RdsParametersMember | DataSourceParameters.RedshiftParametersMember | DataSourceParameters.S3ParametersMember | DataSourceParameters.ServiceNowParametersMember | DataSourceParameters.SnowflakeParametersMember | DataSourceParameters.SparkParametersMember | DataSourceParameters.SqlServerParametersMember | DataSourceParameters.TeradataParametersMember | DataSourceParameters.TwitterParametersMember | DataSourceParameters.$UnknownMember;
|
|
1613
|
+
/**
|
|
1614
|
+
* @public
|
|
1615
|
+
*/
|
|
1497
1616
|
export declare namespace DataSourceParameters {
|
|
1498
1617
|
/**
|
|
1499
1618
|
* <p>The parameters for OpenSearch.</p>
|
|
@@ -2217,6 +2336,7 @@ export declare namespace DataSourceParameters {
|
|
|
2217
2336
|
const visit: <T>(value: DataSourceParameters, visitor: Visitor<T>) => T;
|
|
2218
2337
|
}
|
|
2219
2338
|
/**
|
|
2339
|
+
* @public
|
|
2220
2340
|
* <p>The combination of user name and password that are used as credentials.</p>
|
|
2221
2341
|
*/
|
|
2222
2342
|
export interface CredentialPair {
|
|
@@ -2242,6 +2362,7 @@ export interface CredentialPair {
|
|
|
2242
2362
|
AlternateDataSourceParameters?: DataSourceParameters[];
|
|
2243
2363
|
}
|
|
2244
2364
|
/**
|
|
2365
|
+
* @public
|
|
2245
2366
|
* <p>Data source credentials. This is a variant type structure. For this structure to be
|
|
2246
2367
|
* valid, only one of the attributes can be non-null.</p>
|
|
2247
2368
|
*/
|
|
@@ -2266,6 +2387,7 @@ export interface DataSourceCredentials {
|
|
|
2266
2387
|
SecretArn?: string;
|
|
2267
2388
|
}
|
|
2268
2389
|
/**
|
|
2390
|
+
* @public
|
|
2269
2391
|
* <p>Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your
|
|
2270
2392
|
* underlying data source.</p>
|
|
2271
2393
|
*/
|
|
@@ -2275,6 +2397,9 @@ export interface SslProperties {
|
|
|
2275
2397
|
*/
|
|
2276
2398
|
DisableSsl?: boolean;
|
|
2277
2399
|
}
|
|
2400
|
+
/**
|
|
2401
|
+
* @public
|
|
2402
|
+
*/
|
|
2278
2403
|
export declare enum DataSourceType {
|
|
2279
2404
|
ADOBE_ANALYTICS = "ADOBE_ANALYTICS",
|
|
2280
2405
|
AMAZON_ELASTICSEARCH = "AMAZON_ELASTICSEARCH",
|
|
@@ -2304,6 +2429,7 @@ export declare enum DataSourceType {
|
|
|
2304
2429
|
TWITTER = "TWITTER"
|
|
2305
2430
|
}
|
|
2306
2431
|
/**
|
|
2432
|
+
* @public
|
|
2307
2433
|
* <p>VPC connection properties.</p>
|
|
2308
2434
|
*/
|
|
2309
2435
|
export interface VpcConnectionProperties {
|
|
@@ -2312,6 +2438,9 @@ export interface VpcConnectionProperties {
|
|
|
2312
2438
|
*/
|
|
2313
2439
|
VpcConnectionArn: string | undefined;
|
|
2314
2440
|
}
|
|
2441
|
+
/**
|
|
2442
|
+
* @public
|
|
2443
|
+
*/
|
|
2315
2444
|
export interface CreateDataSourceRequest {
|
|
2316
2445
|
/**
|
|
2317
2446
|
* <p>The Amazon Web Services account ID.</p>
|
|
@@ -2358,6 +2487,9 @@ export interface CreateDataSourceRequest {
|
|
|
2358
2487
|
*/
|
|
2359
2488
|
Tags?: Tag[];
|
|
2360
2489
|
}
|
|
2490
|
+
/**
|
|
2491
|
+
* @public
|
|
2492
|
+
*/
|
|
2361
2493
|
export interface CreateDataSourceResponse {
|
|
2362
2494
|
/**
|
|
2363
2495
|
* <p>The Amazon Resource Name (ARN) of the data source.</p>
|
|
@@ -2380,9 +2512,15 @@ export interface CreateDataSourceResponse {
|
|
|
2380
2512
|
*/
|
|
2381
2513
|
Status?: number;
|
|
2382
2514
|
}
|
|
2515
|
+
/**
|
|
2516
|
+
* @public
|
|
2517
|
+
*/
|
|
2383
2518
|
export declare enum FolderType {
|
|
2384
2519
|
SHARED = "SHARED"
|
|
2385
2520
|
}
|
|
2521
|
+
/**
|
|
2522
|
+
* @public
|
|
2523
|
+
*/
|
|
2386
2524
|
export interface CreateFolderRequest {
|
|
2387
2525
|
/**
|
|
2388
2526
|
* <p>The ID for the Amazon Web Services account where you want to create the folder.</p>
|
|
@@ -2416,6 +2554,9 @@ export interface CreateFolderRequest {
|
|
|
2416
2554
|
*/
|
|
2417
2555
|
Tags?: Tag[];
|
|
2418
2556
|
}
|
|
2557
|
+
/**
|
|
2558
|
+
* @public
|
|
2559
|
+
*/
|
|
2419
2560
|
export interface CreateFolderResponse {
|
|
2420
2561
|
/**
|
|
2421
2562
|
* <p>The HTTP status of the request.</p>
|
|
@@ -2434,11 +2575,17 @@ export interface CreateFolderResponse {
|
|
|
2434
2575
|
*/
|
|
2435
2576
|
RequestId?: string;
|
|
2436
2577
|
}
|
|
2578
|
+
/**
|
|
2579
|
+
* @public
|
|
2580
|
+
*/
|
|
2437
2581
|
export declare enum MemberType {
|
|
2438
2582
|
ANALYSIS = "ANALYSIS",
|
|
2439
2583
|
DASHBOARD = "DASHBOARD",
|
|
2440
2584
|
DATASET = "DATASET"
|
|
2441
2585
|
}
|
|
2586
|
+
/**
|
|
2587
|
+
* @public
|
|
2588
|
+
*/
|
|
2442
2589
|
export interface CreateFolderMembershipRequest {
|
|
2443
2590
|
/**
|
|
2444
2591
|
* <p>The ID for the Amazon Web Services account that contains the folder.</p>
|
|
@@ -2458,6 +2605,7 @@ export interface CreateFolderMembershipRequest {
|
|
|
2458
2605
|
MemberType: MemberType | string | undefined;
|
|
2459
2606
|
}
|
|
2460
2607
|
/**
|
|
2608
|
+
* @public
|
|
2461
2609
|
* <p>An asset in a Amazon QuickSight folder, such as a dashboard, analysis, or dataset.</p>
|
|
2462
2610
|
*/
|
|
2463
2611
|
export interface FolderMember {
|
|
@@ -2470,6 +2618,9 @@ export interface FolderMember {
|
|
|
2470
2618
|
*/
|
|
2471
2619
|
MemberType?: MemberType | string;
|
|
2472
2620
|
}
|
|
2621
|
+
/**
|
|
2622
|
+
* @public
|
|
2623
|
+
*/
|
|
2473
2624
|
export interface CreateFolderMembershipResponse {
|
|
2474
2625
|
/**
|
|
2475
2626
|
* <p>The HTTP status of the request.</p>
|
|
@@ -2485,6 +2636,7 @@ export interface CreateFolderMembershipResponse {
|
|
|
2485
2636
|
RequestId?: string;
|
|
2486
2637
|
}
|
|
2487
2638
|
/**
|
|
2639
|
+
* @public
|
|
2488
2640
|
* <p>The request object for this operation. </p>
|
|
2489
2641
|
*/
|
|
2490
2642
|
export interface CreateGroupRequest {
|
|
@@ -2507,6 +2659,7 @@ export interface CreateGroupRequest {
|
|
|
2507
2659
|
Namespace: string | undefined;
|
|
2508
2660
|
}
|
|
2509
2661
|
/**
|
|
2662
|
+
* @public
|
|
2510
2663
|
* <p>A <i>group</i> in Amazon QuickSight consists of a set of users. You can
|
|
2511
2664
|
* use groups to make it easier to manage access and security. </p>
|
|
2512
2665
|
*/
|
|
@@ -2529,6 +2682,7 @@ export interface Group {
|
|
|
2529
2682
|
PrincipalId?: string;
|
|
2530
2683
|
}
|
|
2531
2684
|
/**
|
|
2685
|
+
* @public
|
|
2532
2686
|
* <p>The response object for this operation.</p>
|
|
2533
2687
|
*/
|
|
2534
2688
|
export interface CreateGroupResponse {
|
|
@@ -2545,6 +2699,9 @@ export interface CreateGroupResponse {
|
|
|
2545
2699
|
*/
|
|
2546
2700
|
Status?: number;
|
|
2547
2701
|
}
|
|
2702
|
+
/**
|
|
2703
|
+
* @public
|
|
2704
|
+
*/
|
|
2548
2705
|
export interface CreateGroupMembershipRequest {
|
|
2549
2706
|
/**
|
|
2550
2707
|
* <p>The name of the user that you want to add to the group membership.</p>
|
|
@@ -2565,6 +2722,7 @@ export interface CreateGroupMembershipRequest {
|
|
|
2565
2722
|
Namespace: string | undefined;
|
|
2566
2723
|
}
|
|
2567
2724
|
/**
|
|
2725
|
+
* @public
|
|
2568
2726
|
* <p>A member of an Amazon QuickSight group. Currently, group members must be users. Groups
|
|
2569
2727
|
* can't be members of another group. .</p>
|
|
2570
2728
|
*/
|
|
@@ -2578,6 +2736,9 @@ export interface GroupMember {
|
|
|
2578
2736
|
*/
|
|
2579
2737
|
MemberName?: string;
|
|
2580
2738
|
}
|
|
2739
|
+
/**
|
|
2740
|
+
* @public
|
|
2741
|
+
*/
|
|
2581
2742
|
export interface CreateGroupMembershipResponse {
|
|
2582
2743
|
/**
|
|
2583
2744
|
* <p>The group member.</p>
|
|
@@ -2592,6 +2753,9 @@ export interface CreateGroupMembershipResponse {
|
|
|
2592
2753
|
*/
|
|
2593
2754
|
Status?: number;
|
|
2594
2755
|
}
|
|
2756
|
+
/**
|
|
2757
|
+
* @public
|
|
2758
|
+
*/
|
|
2595
2759
|
export interface CreateIAMPolicyAssignmentRequest {
|
|
2596
2760
|
/**
|
|
2597
2761
|
* <p>The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or
|
|
@@ -2636,6 +2800,9 @@ export interface CreateIAMPolicyAssignmentRequest {
|
|
|
2636
2800
|
*/
|
|
2637
2801
|
Namespace: string | undefined;
|
|
2638
2802
|
}
|
|
2803
|
+
/**
|
|
2804
|
+
* @public
|
|
2805
|
+
*/
|
|
2639
2806
|
export interface CreateIAMPolicyAssignmentResponse {
|
|
2640
2807
|
/**
|
|
2641
2808
|
* <p>The name of the assignment. This name must be unique within the Amazon Web Services account.</p>
|
|
@@ -2682,10 +2849,16 @@ export interface CreateIAMPolicyAssignmentResponse {
|
|
|
2682
2849
|
*/
|
|
2683
2850
|
Status?: number;
|
|
2684
2851
|
}
|
|
2852
|
+
/**
|
|
2853
|
+
* @public
|
|
2854
|
+
*/
|
|
2685
2855
|
export declare enum IngestionType {
|
|
2686
2856
|
FULL_REFRESH = "FULL_REFRESH",
|
|
2687
2857
|
INCREMENTAL_REFRESH = "INCREMENTAL_REFRESH"
|
|
2688
2858
|
}
|
|
2859
|
+
/**
|
|
2860
|
+
* @public
|
|
2861
|
+
*/
|
|
2689
2862
|
export interface CreateIngestionRequest {
|
|
2690
2863
|
/**
|
|
2691
2864
|
* <p>The ID of the dataset used in the ingestion.</p>
|
|
@@ -2704,6 +2877,9 @@ export interface CreateIngestionRequest {
|
|
|
2704
2877
|
*/
|
|
2705
2878
|
IngestionType?: IngestionType | string;
|
|
2706
2879
|
}
|
|
2880
|
+
/**
|
|
2881
|
+
* @public
|
|
2882
|
+
*/
|
|
2707
2883
|
export declare enum IngestionStatus {
|
|
2708
2884
|
CANCELLED = "CANCELLED",
|
|
2709
2885
|
COMPLETED = "COMPLETED",
|
|
@@ -2712,6 +2888,9 @@ export declare enum IngestionStatus {
|
|
|
2712
2888
|
QUEUED = "QUEUED",
|
|
2713
2889
|
RUNNING = "RUNNING"
|
|
2714
2890
|
}
|
|
2891
|
+
/**
|
|
2892
|
+
* @public
|
|
2893
|
+
*/
|
|
2715
2894
|
export interface CreateIngestionResponse {
|
|
2716
2895
|
/**
|
|
2717
2896
|
* <p>The Amazon Resource Name (ARN) for the data ingestion.</p>
|
|
@@ -2734,9 +2913,15 @@ export interface CreateIngestionResponse {
|
|
|
2734
2913
|
*/
|
|
2735
2914
|
Status?: number;
|
|
2736
2915
|
}
|
|
2916
|
+
/**
|
|
2917
|
+
* @public
|
|
2918
|
+
*/
|
|
2737
2919
|
export declare enum IdentityStore {
|
|
2738
2920
|
QUICKSIGHT = "QUICKSIGHT"
|
|
2739
2921
|
}
|
|
2922
|
+
/**
|
|
2923
|
+
* @public
|
|
2924
|
+
*/
|
|
2740
2925
|
export interface CreateNamespaceRequest {
|
|
2741
2926
|
/**
|
|
2742
2927
|
* <p>The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in.</p>
|
|
@@ -2756,6 +2941,9 @@ export interface CreateNamespaceRequest {
|
|
|
2756
2941
|
*/
|
|
2757
2942
|
Tags?: Tag[];
|
|
2758
2943
|
}
|
|
2944
|
+
/**
|
|
2945
|
+
* @public
|
|
2946
|
+
*/
|
|
2759
2947
|
export declare enum NamespaceStatus {
|
|
2760
2948
|
CREATED = "CREATED",
|
|
2761
2949
|
CREATING = "CREATING",
|
|
@@ -2763,6 +2951,9 @@ export declare enum NamespaceStatus {
|
|
|
2763
2951
|
NON_RETRYABLE_FAILURE = "NON_RETRYABLE_FAILURE",
|
|
2764
2952
|
RETRYABLE_FAILURE = "RETRYABLE_FAILURE"
|
|
2765
2953
|
}
|
|
2954
|
+
/**
|
|
2955
|
+
* @public
|
|
2956
|
+
*/
|
|
2766
2957
|
export interface CreateNamespaceResponse {
|
|
2767
2958
|
/**
|
|
2768
2959
|
* <p>The ARN of the Amazon QuickSight namespace you created. </p>
|
|
@@ -2800,6 +2991,7 @@ export interface CreateNamespaceResponse {
|
|
|
2800
2991
|
Status?: number;
|
|
2801
2992
|
}
|
|
2802
2993
|
/**
|
|
2994
|
+
* @public
|
|
2803
2995
|
* <p>Dataset schema.</p>
|
|
2804
2996
|
*/
|
|
2805
2997
|
export interface DataSetSchema {
|
|
@@ -2809,6 +3001,7 @@ export interface DataSetSchema {
|
|
|
2809
3001
|
ColumnSchemaList?: ColumnSchema[];
|
|
2810
3002
|
}
|
|
2811
3003
|
/**
|
|
3004
|
+
* @public
|
|
2812
3005
|
* <p>Dataset configuration.</p>
|
|
2813
3006
|
*/
|
|
2814
3007
|
export interface DataSetConfiguration {
|
|
@@ -2826,6 +3019,7 @@ export interface DataSetConfiguration {
|
|
|
2826
3019
|
ColumnGroupSchemaList?: ColumnGroupSchema[];
|
|
2827
3020
|
}
|
|
2828
3021
|
/**
|
|
3022
|
+
* @public
|
|
2829
3023
|
* <p>The detailed definition of a template.</p>
|
|
2830
3024
|
*/
|
|
2831
3025
|
export interface TemplateVersionDefinition {
|
|
@@ -2867,6 +3061,7 @@ export interface TemplateVersionDefinition {
|
|
|
2867
3061
|
AnalysisDefaults?: AnalysisDefaults;
|
|
2868
3062
|
}
|
|
2869
3063
|
/**
|
|
3064
|
+
* @public
|
|
2870
3065
|
* <p>The source analysis of the template.</p>
|
|
2871
3066
|
*/
|
|
2872
3067
|
export interface TemplateSourceAnalysis {
|
|
@@ -2881,6 +3076,7 @@ export interface TemplateSourceAnalysis {
|
|
|
2881
3076
|
DataSetReferences: DataSetReference[] | undefined;
|
|
2882
3077
|
}
|
|
2883
3078
|
/**
|
|
3079
|
+
* @public
|
|
2884
3080
|
* <p>The source template of the template.</p>
|
|
2885
3081
|
*/
|
|
2886
3082
|
export interface TemplateSourceTemplate {
|
|
@@ -2890,6 +3086,7 @@ export interface TemplateSourceTemplate {
|
|
|
2890
3086
|
Arn: string | undefined;
|
|
2891
3087
|
}
|
|
2892
3088
|
/**
|
|
3089
|
+
* @public
|
|
2893
3090
|
* <p>The source entity of the template.</p>
|
|
2894
3091
|
*/
|
|
2895
3092
|
export interface TemplateSourceEntity {
|
|
@@ -2902,6 +3099,9 @@ export interface TemplateSourceEntity {
|
|
|
2902
3099
|
*/
|
|
2903
3100
|
SourceTemplate?: TemplateSourceTemplate;
|
|
2904
3101
|
}
|
|
3102
|
+
/**
|
|
3103
|
+
* @public
|
|
3104
|
+
*/
|
|
2905
3105
|
export interface CreateTemplateRequest {
|
|
2906
3106
|
/**
|
|
2907
3107
|
* <p>The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.</p>
|
|
@@ -2954,6 +3154,9 @@ export interface CreateTemplateRequest {
|
|
|
2954
3154
|
*/
|
|
2955
3155
|
Definition?: TemplateVersionDefinition;
|
|
2956
3156
|
}
|
|
3157
|
+
/**
|
|
3158
|
+
* @public
|
|
3159
|
+
*/
|
|
2957
3160
|
export interface CreateTemplateResponse {
|
|
2958
3161
|
/**
|
|
2959
3162
|
* <p>The ARN for the template.</p>
|
|
@@ -2981,6 +3184,9 @@ export interface CreateTemplateResponse {
|
|
|
2981
3184
|
*/
|
|
2982
3185
|
RequestId?: string;
|
|
2983
3186
|
}
|
|
3187
|
+
/**
|
|
3188
|
+
* @public
|
|
3189
|
+
*/
|
|
2984
3190
|
export interface CreateTemplateAliasRequest {
|
|
2985
3191
|
/**
|
|
2986
3192
|
* <p>The ID of the Amazon Web Services account that contains the template that you creating an alias for.</p>
|
|
@@ -3002,6 +3208,7 @@ export interface CreateTemplateAliasRequest {
|
|
|
3002
3208
|
TemplateVersionNumber: number | undefined;
|
|
3003
3209
|
}
|
|
3004
3210
|
/**
|
|
3211
|
+
* @public
|
|
3005
3212
|
* <p>The template alias.</p>
|
|
3006
3213
|
*/
|
|
3007
3214
|
export interface TemplateAlias {
|
|
@@ -3018,6 +3225,9 @@ export interface TemplateAlias {
|
|
|
3018
3225
|
*/
|
|
3019
3226
|
TemplateVersionNumber?: number;
|
|
3020
3227
|
}
|
|
3228
|
+
/**
|
|
3229
|
+
* @public
|
|
3230
|
+
*/
|
|
3021
3231
|
export interface CreateTemplateAliasResponse {
|
|
3022
3232
|
/**
|
|
3023
3233
|
* <p>Information about the template alias.</p>
|
|
@@ -3033,6 +3243,7 @@ export interface CreateTemplateAliasResponse {
|
|
|
3033
3243
|
RequestId?: string;
|
|
3034
3244
|
}
|
|
3035
3245
|
/**
|
|
3246
|
+
* @public
|
|
3036
3247
|
* <p>The theme colors that are used for data colors in charts. The colors description is a
|
|
3037
3248
|
* hexadecimal color code that consists of six alphanumerical characters, prefixed with
|
|
3038
3249
|
* <code>#</code>, for example #37BFF5. </p>
|
|
@@ -3053,6 +3264,7 @@ export interface DataColorPalette {
|
|
|
3053
3264
|
EmptyFillColor?: string;
|
|
3054
3265
|
}
|
|
3055
3266
|
/**
|
|
3267
|
+
* @public
|
|
3056
3268
|
* <p>Display options related to tiles on a sheet.</p>
|
|
3057
3269
|
*/
|
|
3058
3270
|
export interface TileStyle {
|
|
@@ -3062,6 +3274,7 @@ export interface TileStyle {
|
|
|
3062
3274
|
Border?: BorderStyle;
|
|
3063
3275
|
}
|
|
3064
3276
|
/**
|
|
3277
|
+
* @public
|
|
3065
3278
|
* <p>The display options for gutter spacing between tiles on a sheet.</p>
|
|
3066
3279
|
*/
|
|
3067
3280
|
export interface GutterStyle {
|
|
@@ -3072,6 +3285,7 @@ export interface GutterStyle {
|
|
|
3072
3285
|
Show?: boolean;
|
|
3073
3286
|
}
|
|
3074
3287
|
/**
|
|
3288
|
+
* @public
|
|
3075
3289
|
* <p>The display options for margins around the outside edge of sheets.</p>
|
|
3076
3290
|
*/
|
|
3077
3291
|
export interface MarginStyle {
|
|
@@ -3081,6 +3295,7 @@ export interface MarginStyle {
|
|
|
3081
3295
|
Show?: boolean;
|
|
3082
3296
|
}
|
|
3083
3297
|
/**
|
|
3298
|
+
* @public
|
|
3084
3299
|
* <p>The display options for the layout of tiles on a sheet.</p>
|
|
3085
3300
|
*/
|
|
3086
3301
|
export interface TileLayoutStyle {
|
|
@@ -3094,6 +3309,7 @@ export interface TileLayoutStyle {
|
|
|
3094
3309
|
Margin?: MarginStyle;
|
|
3095
3310
|
}
|
|
3096
3311
|
/**
|
|
3312
|
+
* @public
|
|
3097
3313
|
* <p>The theme display options for sheets. </p>
|
|
3098
3314
|
*/
|
|
3099
3315
|
export interface SheetStyle {
|
|
@@ -3107,6 +3323,7 @@ export interface SheetStyle {
|
|
|
3107
3323
|
TileLayout?: TileLayoutStyle;
|
|
3108
3324
|
}
|
|
3109
3325
|
/**
|
|
3326
|
+
* @public
|
|
3110
3327
|
* <p>Determines the font settings.</p>
|
|
3111
3328
|
*/
|
|
3112
3329
|
export interface Font {
|
|
@@ -3116,6 +3333,7 @@ export interface Font {
|
|
|
3116
3333
|
FontFamily?: string;
|
|
3117
3334
|
}
|
|
3118
3335
|
/**
|
|
3336
|
+
* @public
|
|
3119
3337
|
* <p>Determines the typography options.</p>
|
|
3120
3338
|
*/
|
|
3121
3339
|
export interface Typography {
|
|
@@ -3125,6 +3343,7 @@ export interface Typography {
|
|
|
3125
3343
|
FontFamilies?: Font[];
|
|
3126
3344
|
}
|
|
3127
3345
|
/**
|
|
3346
|
+
* @public
|
|
3128
3347
|
* <p>The theme colors that apply to UI and to charts, excluding data colors. The colors
|
|
3129
3348
|
* description is a hexadecimal color code that consists of six alphanumerical characters,
|
|
3130
3349
|
* prefixed with <code>#</code>, for example #37BFF5. For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html">Using Themes in Amazon QuickSight</a> in the <i>Amazon QuickSight User
|
|
@@ -3208,6 +3427,7 @@ export interface UIColorPalette {
|
|
|
3208
3427
|
MeasureForeground?: string;
|
|
3209
3428
|
}
|
|
3210
3429
|
/**
|
|
3430
|
+
* @public
|
|
3211
3431
|
* <p>The theme configuration. This configuration contains all of the display properties for
|
|
3212
3432
|
* a theme.</p>
|
|
3213
3433
|
*/
|
|
@@ -3230,6 +3450,9 @@ export interface ThemeConfiguration {
|
|
|
3230
3450
|
*/
|
|
3231
3451
|
Typography?: Typography;
|
|
3232
3452
|
}
|
|
3453
|
+
/**
|
|
3454
|
+
* @public
|
|
3455
|
+
*/
|
|
3233
3456
|
export interface CreateThemeRequest {
|
|
3234
3457
|
/**
|
|
3235
3458
|
* <p>The ID of the Amazon Web Services account where you want to store the new theme. </p>
|
|
@@ -3273,6 +3496,9 @@ export interface CreateThemeRequest {
|
|
|
3273
3496
|
*/
|
|
3274
3497
|
Tags?: Tag[];
|
|
3275
3498
|
}
|
|
3499
|
+
/**
|
|
3500
|
+
* @public
|
|
3501
|
+
*/
|
|
3276
3502
|
export interface CreateThemeResponse {
|
|
3277
3503
|
/**
|
|
3278
3504
|
* <p>The Amazon Resource Name (ARN) for the theme.</p>
|
|
@@ -3299,6 +3525,9 @@ export interface CreateThemeResponse {
|
|
|
3299
3525
|
*/
|
|
3300
3526
|
RequestId?: string;
|
|
3301
3527
|
}
|
|
3528
|
+
/**
|
|
3529
|
+
* @public
|
|
3530
|
+
*/
|
|
3302
3531
|
export interface CreateThemeAliasRequest {
|
|
3303
3532
|
/**
|
|
3304
3533
|
* <p>The ID of the Amazon Web Services account that contains the theme for the new theme alias.</p>
|
|
@@ -3320,6 +3549,7 @@ export interface CreateThemeAliasRequest {
|
|
|
3320
3549
|
ThemeVersionNumber: number | undefined;
|
|
3321
3550
|
}
|
|
3322
3551
|
/**
|
|
3552
|
+
* @public
|
|
3323
3553
|
* <p>An alias for a theme.</p>
|
|
3324
3554
|
*/
|
|
3325
3555
|
export interface ThemeAlias {
|
|
@@ -3336,6 +3566,9 @@ export interface ThemeAlias {
|
|
|
3336
3566
|
*/
|
|
3337
3567
|
ThemeVersionNumber?: number;
|
|
3338
3568
|
}
|
|
3569
|
+
/**
|
|
3570
|
+
* @public
|
|
3571
|
+
*/
|
|
3339
3572
|
export interface CreateThemeAliasResponse {
|
|
3340
3573
|
/**
|
|
3341
3574
|
* <p>Information about the theme alias.</p>
|
|
@@ -3350,6 +3583,9 @@ export interface CreateThemeAliasResponse {
|
|
|
3350
3583
|
*/
|
|
3351
3584
|
RequestId?: string;
|
|
3352
3585
|
}
|
|
3586
|
+
/**
|
|
3587
|
+
* @public
|
|
3588
|
+
*/
|
|
3353
3589
|
export declare enum DashboardErrorType {
|
|
3354
3590
|
ACCESS_DENIED = "ACCESS_DENIED",
|
|
3355
3591
|
COLUMN_GEOGRAPHIC_ROLE_MISMATCH = "COLUMN_GEOGRAPHIC_ROLE_MISMATCH",
|
|
@@ -3363,6 +3599,7 @@ export declare enum DashboardErrorType {
|
|
|
3363
3599
|
SOURCE_NOT_FOUND = "SOURCE_NOT_FOUND"
|
|
3364
3600
|
}
|
|
3365
3601
|
/**
|
|
3602
|
+
* @public
|
|
3366
3603
|
* <p>Dashboard error.</p>
|
|
3367
3604
|
*/
|
|
3368
3605
|
export interface DashboardError {
|
|
@@ -3380,6 +3617,7 @@ export interface DashboardError {
|
|
|
3380
3617
|
ViolatedEntities?: Entity[];
|
|
3381
3618
|
}
|
|
3382
3619
|
/**
|
|
3620
|
+
* @public
|
|
3383
3621
|
* <p>Dashboard version.</p>
|
|
3384
3622
|
*/
|
|
3385
3623
|
export interface DashboardVersion {
|
|
@@ -3426,6 +3664,7 @@ export interface DashboardVersion {
|
|
|
3426
3664
|
Sheets?: Sheet[];
|
|
3427
3665
|
}
|
|
3428
3666
|
/**
|
|
3667
|
+
* @public
|
|
3429
3668
|
* <p>Dashboard.</p>
|
|
3430
3669
|
*/
|
|
3431
3670
|
export interface Dashboard {
|
|
@@ -3458,6 +3697,9 @@ export interface Dashboard {
|
|
|
3458
3697
|
*/
|
|
3459
3698
|
LastUpdatedTime?: Date;
|
|
3460
3699
|
}
|
|
3700
|
+
/**
|
|
3701
|
+
* @public
|
|
3702
|
+
*/
|
|
3461
3703
|
export declare enum DashboardFilterAttribute {
|
|
3462
3704
|
DASHBOARD_NAME = "DASHBOARD_NAME",
|
|
3463
3705
|
DIRECT_QUICKSIGHT_OWNER = "DIRECT_QUICKSIGHT_OWNER",
|
|
@@ -3468,6 +3710,7 @@ export declare enum DashboardFilterAttribute {
|
|
|
3468
3710
|
QUICKSIGHT_VIEWER_OR_OWNER = "QUICKSIGHT_VIEWER_OR_OWNER"
|
|
3469
3711
|
}
|
|
3470
3712
|
/**
|
|
3713
|
+
* @public
|
|
3471
3714
|
* <p>A filter that you apply when searching for dashboards. </p>
|
|
3472
3715
|
*/
|
|
3473
3716
|
export interface DashboardSearchFilter {
|
|
@@ -3517,6 +3760,7 @@ export interface DashboardSearchFilter {
|
|
|
3517
3760
|
Value?: string;
|
|
3518
3761
|
}
|
|
3519
3762
|
/**
|
|
3763
|
+
* @public
|
|
3520
3764
|
* <p>Dashboard summary.</p>
|
|
3521
3765
|
*/
|
|
3522
3766
|
export interface DashboardSummary {
|
|
@@ -3550,6 +3794,7 @@ export interface DashboardSummary {
|
|
|
3550
3794
|
LastPublishedTime?: Date;
|
|
3551
3795
|
}
|
|
3552
3796
|
/**
|
|
3797
|
+
* @public
|
|
3553
3798
|
* <p>Dashboard version summary.</p>
|
|
3554
3799
|
*/
|
|
3555
3800
|
export interface DashboardVersionSummary {
|
|
@@ -3579,6 +3824,7 @@ export interface DashboardVersionSummary {
|
|
|
3579
3824
|
Description?: string;
|
|
3580
3825
|
}
|
|
3581
3826
|
/**
|
|
3827
|
+
* @public
|
|
3582
3828
|
* <p>Output column.</p>
|
|
3583
3829
|
*/
|
|
3584
3830
|
export interface OutputColumn {
|
|
@@ -3596,6 +3842,7 @@ export interface OutputColumn {
|
|
|
3596
3842
|
Type?: ColumnDataType | string;
|
|
3597
3843
|
}
|
|
3598
3844
|
/**
|
|
3845
|
+
* @public
|
|
3599
3846
|
* <p>Dataset.</p>
|
|
3600
3847
|
*/
|
|
3601
3848
|
export interface DataSet {
|
|
@@ -3670,6 +3917,9 @@ export interface DataSet {
|
|
|
3670
3917
|
*/
|
|
3671
3918
|
DataSetUsageConfiguration?: DataSetUsageConfiguration;
|
|
3672
3919
|
}
|
|
3920
|
+
/**
|
|
3921
|
+
* @public
|
|
3922
|
+
*/
|
|
3673
3923
|
export declare enum DataSetFilterAttribute {
|
|
3674
3924
|
DATASET_NAME = "DATASET_NAME",
|
|
3675
3925
|
DIRECT_QUICKSIGHT_OWNER = "DIRECT_QUICKSIGHT_OWNER",
|
|
@@ -3679,6 +3929,7 @@ export declare enum DataSetFilterAttribute {
|
|
|
3679
3929
|
QUICKSIGHT_VIEWER_OR_OWNER = "QUICKSIGHT_VIEWER_OR_OWNER"
|
|
3680
3930
|
}
|
|
3681
3931
|
/**
|
|
3932
|
+
* @public
|
|
3682
3933
|
* <p>A filter that you apply when searching for datasets.</p>
|
|
3683
3934
|
*/
|
|
3684
3935
|
export interface DataSetSearchFilter {
|
|
@@ -3728,6 +3979,7 @@ export interface DataSetSearchFilter {
|
|
|
3728
3979
|
Value: string | undefined;
|
|
3729
3980
|
}
|
|
3730
3981
|
/**
|
|
3982
|
+
* @public
|
|
3731
3983
|
* <p>Dataset summary.</p>
|
|
3732
3984
|
*/
|
|
3733
3985
|
export interface DataSetSummary {
|
|
@@ -3768,6 +4020,9 @@ export interface DataSetSummary {
|
|
|
3768
4020
|
*/
|
|
3769
4021
|
ColumnLevelPermissionRulesApplied?: boolean;
|
|
3770
4022
|
}
|
|
4023
|
+
/**
|
|
4024
|
+
* @public
|
|
4025
|
+
*/
|
|
3771
4026
|
export declare enum DataSourceErrorInfoType {
|
|
3772
4027
|
ACCESS_DENIED = "ACCESS_DENIED",
|
|
3773
4028
|
CONFLICT = "CONFLICT",
|
|
@@ -3779,6 +4034,7 @@ export declare enum DataSourceErrorInfoType {
|
|
|
3779
4034
|
UNKNOWN_HOST = "UNKNOWN_HOST"
|
|
3780
4035
|
}
|
|
3781
4036
|
/**
|
|
4037
|
+
* @public
|
|
3782
4038
|
* <p>Error information for the data source creation or update.</p>
|
|
3783
4039
|
*/
|
|
3784
4040
|
export interface DataSourceErrorInfo {
|
|
@@ -3792,6 +4048,7 @@ export interface DataSourceErrorInfo {
|
|
|
3792
4048
|
Message?: string;
|
|
3793
4049
|
}
|
|
3794
4050
|
/**
|
|
4051
|
+
* @public
|
|
3795
4052
|
* <p>The structure of a data source.</p>
|
|
3796
4053
|
*/
|
|
3797
4054
|
export interface DataSource {
|
|
@@ -3862,6 +4119,9 @@ export interface DataSource {
|
|
|
3862
4119
|
*/
|
|
3863
4120
|
SecretArn?: string;
|
|
3864
4121
|
}
|
|
4122
|
+
/**
|
|
4123
|
+
* @public
|
|
4124
|
+
*/
|
|
3865
4125
|
export declare enum DataSourceFilterAttribute {
|
|
3866
4126
|
DATASOURCE_NAME = "DATASOURCE_NAME",
|
|
3867
4127
|
DIRECT_QUICKSIGHT_OWNER = "DIRECT_QUICKSIGHT_OWNER",
|
|
@@ -3869,6 +4129,7 @@ export declare enum DataSourceFilterAttribute {
|
|
|
3869
4129
|
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER = "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER"
|
|
3870
4130
|
}
|
|
3871
4131
|
/**
|
|
4132
|
+
* @public
|
|
3872
4133
|
* <p>A filter that you apply when searching for data sources.</p>
|
|
3873
4134
|
*/
|
|
3874
4135
|
export interface DataSourceSearchFilter {
|
|
@@ -3910,6 +4171,7 @@ export interface DataSourceSearchFilter {
|
|
|
3910
4171
|
Value: string | undefined;
|
|
3911
4172
|
}
|
|
3912
4173
|
/**
|
|
4174
|
+
* @public
|
|
3913
4175
|
* <p>A <code>DataSourceSummary</code> object that returns a summary of a data source.</p>
|
|
3914
4176
|
*/
|
|
3915
4177
|
export interface DataSourceSummary {
|
|
@@ -3938,6 +4200,9 @@ export interface DataSourceSummary {
|
|
|
3938
4200
|
*/
|
|
3939
4201
|
LastUpdatedTime?: Date;
|
|
3940
4202
|
}
|
|
4203
|
+
/**
|
|
4204
|
+
* @public
|
|
4205
|
+
*/
|
|
3941
4206
|
export interface DeleteAccountCustomizationRequest {
|
|
3942
4207
|
/**
|
|
3943
4208
|
* <p>The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in
|
|
@@ -3949,6 +4214,9 @@ export interface DeleteAccountCustomizationRequest {
|
|
|
3949
4214
|
*/
|
|
3950
4215
|
Namespace?: string;
|
|
3951
4216
|
}
|
|
4217
|
+
/**
|
|
4218
|
+
* @public
|
|
4219
|
+
*/
|
|
3952
4220
|
export interface DeleteAccountCustomizationResponse {
|
|
3953
4221
|
/**
|
|
3954
4222
|
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
@@ -3959,12 +4227,18 @@ export interface DeleteAccountCustomizationResponse {
|
|
|
3959
4227
|
*/
|
|
3960
4228
|
Status?: number;
|
|
3961
4229
|
}
|
|
4230
|
+
/**
|
|
4231
|
+
* @public
|
|
4232
|
+
*/
|
|
3962
4233
|
export interface DeleteAccountSubscriptionRequest {
|
|
3963
4234
|
/**
|
|
3964
4235
|
* <p>The Amazon Web Services account ID of the account that you want to delete.</p>
|
|
3965
4236
|
*/
|
|
3966
4237
|
AwsAccountId: string | undefined;
|
|
3967
4238
|
}
|
|
4239
|
+
/**
|
|
4240
|
+
* @public
|
|
4241
|
+
*/
|
|
3968
4242
|
export interface DeleteAccountSubscriptionResponse {
|
|
3969
4243
|
/**
|
|
3970
4244
|
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
@@ -3975,6 +4249,9 @@ export interface DeleteAccountSubscriptionResponse {
|
|
|
3975
4249
|
*/
|
|
3976
4250
|
Status?: number;
|
|
3977
4251
|
}
|
|
4252
|
+
/**
|
|
4253
|
+
* @public
|
|
4254
|
+
*/
|
|
3978
4255
|
export interface DeleteAnalysisRequest {
|
|
3979
4256
|
/**
|
|
3980
4257
|
* <p>The ID of the Amazon Web Services account where you want to delete an analysis.</p>
|
|
@@ -3997,6 +4274,9 @@ export interface DeleteAnalysisRequest {
|
|
|
3997
4274
|
*/
|
|
3998
4275
|
ForceDeleteWithoutRecovery?: boolean;
|
|
3999
4276
|
}
|
|
4277
|
+
/**
|
|
4278
|
+
* @public
|
|
4279
|
+
*/
|
|
4000
4280
|
export interface DeleteAnalysisResponse {
|
|
4001
4281
|
/**
|
|
4002
4282
|
* <p>The HTTP status of the request.</p>
|
|
@@ -4019,6 +4299,9 @@ export interface DeleteAnalysisResponse {
|
|
|
4019
4299
|
*/
|
|
4020
4300
|
RequestId?: string;
|
|
4021
4301
|
}
|
|
4302
|
+
/**
|
|
4303
|
+
* @public
|
|
4304
|
+
*/
|
|
4022
4305
|
export interface DeleteDashboardRequest {
|
|
4023
4306
|
/**
|
|
4024
4307
|
* <p>The ID of the Amazon Web Services account that contains the dashboard that you're
|
|
@@ -4035,6 +4318,9 @@ export interface DeleteDashboardRequest {
|
|
|
4035
4318
|
*/
|
|
4036
4319
|
VersionNumber?: number;
|
|
4037
4320
|
}
|
|
4321
|
+
/**
|
|
4322
|
+
* @public
|
|
4323
|
+
*/
|
|
4038
4324
|
export interface DeleteDashboardResponse {
|
|
4039
4325
|
/**
|
|
4040
4326
|
* <p>The HTTP status of the request.</p>
|
|
@@ -4053,6 +4339,9 @@ export interface DeleteDashboardResponse {
|
|
|
4053
4339
|
*/
|
|
4054
4340
|
RequestId?: string;
|
|
4055
4341
|
}
|
|
4342
|
+
/**
|
|
4343
|
+
* @public
|
|
4344
|
+
*/
|
|
4056
4345
|
export interface DeleteDataSetRequest {
|
|
4057
4346
|
/**
|
|
4058
4347
|
* <p>The Amazon Web Services account ID.</p>
|
|
@@ -4063,6 +4352,9 @@ export interface DeleteDataSetRequest {
|
|
|
4063
4352
|
*/
|
|
4064
4353
|
DataSetId: string | undefined;
|
|
4065
4354
|
}
|
|
4355
|
+
/**
|
|
4356
|
+
* @public
|
|
4357
|
+
*/
|
|
4066
4358
|
export interface DeleteDataSetResponse {
|
|
4067
4359
|
/**
|
|
4068
4360
|
* <p>The Amazon Resource Name (ARN) of the dataset.</p>
|
|
@@ -4081,6 +4373,9 @@ export interface DeleteDataSetResponse {
|
|
|
4081
4373
|
*/
|
|
4082
4374
|
Status?: number;
|
|
4083
4375
|
}
|
|
4376
|
+
/**
|
|
4377
|
+
* @public
|
|
4378
|
+
*/
|
|
4084
4379
|
export interface DeleteDataSourceRequest {
|
|
4085
4380
|
/**
|
|
4086
4381
|
* <p>The Amazon Web Services account ID.</p>
|
|
@@ -4091,6 +4386,9 @@ export interface DeleteDataSourceRequest {
|
|
|
4091
4386
|
*/
|
|
4092
4387
|
DataSourceId: string | undefined;
|
|
4093
4388
|
}
|
|
4389
|
+
/**
|
|
4390
|
+
* @public
|
|
4391
|
+
*/
|
|
4094
4392
|
export interface DeleteDataSourceResponse {
|
|
4095
4393
|
/**
|
|
4096
4394
|
* <p>The Amazon Resource Name (ARN) of the data source that you deleted.</p>
|
|
@@ -4109,6 +4407,9 @@ export interface DeleteDataSourceResponse {
|
|
|
4109
4407
|
*/
|
|
4110
4408
|
Status?: number;
|
|
4111
4409
|
}
|
|
4410
|
+
/**
|
|
4411
|
+
* @public
|
|
4412
|
+
*/
|
|
4112
4413
|
export interface DeleteFolderRequest {
|
|
4113
4414
|
/**
|
|
4114
4415
|
* <p>The ID for the Amazon Web Services account that contains the folder.</p>
|
|
@@ -4119,6 +4420,9 @@ export interface DeleteFolderRequest {
|
|
|
4119
4420
|
*/
|
|
4120
4421
|
FolderId: string | undefined;
|
|
4121
4422
|
}
|
|
4423
|
+
/**
|
|
4424
|
+
* @public
|
|
4425
|
+
*/
|
|
4122
4426
|
export interface DeleteFolderResponse {
|
|
4123
4427
|
/**
|
|
4124
4428
|
* <p>The HTTP status of the request.</p>
|
|
@@ -4137,6 +4441,9 @@ export interface DeleteFolderResponse {
|
|
|
4137
4441
|
*/
|
|
4138
4442
|
RequestId?: string;
|
|
4139
4443
|
}
|
|
4444
|
+
/**
|
|
4445
|
+
* @public
|
|
4446
|
+
*/
|
|
4140
4447
|
export interface DeleteFolderMembershipRequest {
|
|
4141
4448
|
/**
|
|
4142
4449
|
* <p>The ID for the Amazon Web Services account that contains the folder.</p>
|
|
@@ -4156,6 +4463,9 @@ export interface DeleteFolderMembershipRequest {
|
|
|
4156
4463
|
*/
|
|
4157
4464
|
MemberType: MemberType | string | undefined;
|
|
4158
4465
|
}
|
|
4466
|
+
/**
|
|
4467
|
+
* @public
|
|
4468
|
+
*/
|
|
4159
4469
|
export interface DeleteFolderMembershipResponse {
|
|
4160
4470
|
/**
|
|
4161
4471
|
* <p>The HTTP status of the request.</p>
|
|
@@ -4166,6 +4476,9 @@ export interface DeleteFolderMembershipResponse {
|
|
|
4166
4476
|
*/
|
|
4167
4477
|
RequestId?: string;
|
|
4168
4478
|
}
|
|
4479
|
+
/**
|
|
4480
|
+
* @public
|
|
4481
|
+
*/
|
|
4169
4482
|
export interface DeleteGroupRequest {
|
|
4170
4483
|
/**
|
|
4171
4484
|
* <p>The name of the group that you want to delete.</p>
|
|
@@ -4181,6 +4494,9 @@ export interface DeleteGroupRequest {
|
|
|
4181
4494
|
*/
|
|
4182
4495
|
Namespace: string | undefined;
|
|
4183
4496
|
}
|
|
4497
|
+
/**
|
|
4498
|
+
* @public
|
|
4499
|
+
*/
|
|
4184
4500
|
export interface DeleteGroupResponse {
|
|
4185
4501
|
/**
|
|
4186
4502
|
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
@@ -4191,6 +4507,9 @@ export interface DeleteGroupResponse {
|
|
|
4191
4507
|
*/
|
|
4192
4508
|
Status?: number;
|
|
4193
4509
|
}
|
|
4510
|
+
/**
|
|
4511
|
+
* @public
|
|
4512
|
+
*/
|
|
4194
4513
|
export interface DeleteGroupMembershipRequest {
|
|
4195
4514
|
/**
|
|
4196
4515
|
* <p>The name of the user that you want to delete from the group membership.</p>
|
|
@@ -4210,6 +4529,9 @@ export interface DeleteGroupMembershipRequest {
|
|
|
4210
4529
|
*/
|
|
4211
4530
|
Namespace: string | undefined;
|
|
4212
4531
|
}
|
|
4532
|
+
/**
|
|
4533
|
+
* @public
|
|
4534
|
+
*/
|
|
4213
4535
|
export interface DeleteGroupMembershipResponse {
|
|
4214
4536
|
/**
|
|
4215
4537
|
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
@@ -4220,6 +4542,9 @@ export interface DeleteGroupMembershipResponse {
|
|
|
4220
4542
|
*/
|
|
4221
4543
|
Status?: number;
|
|
4222
4544
|
}
|
|
4545
|
+
/**
|
|
4546
|
+
* @public
|
|
4547
|
+
*/
|
|
4223
4548
|
export interface DeleteIAMPolicyAssignmentRequest {
|
|
4224
4549
|
/**
|
|
4225
4550
|
* <p>The Amazon Web Services account ID where you want to delete the IAM policy assignment.</p>
|
|
@@ -4234,6 +4559,9 @@ export interface DeleteIAMPolicyAssignmentRequest {
|
|
|
4234
4559
|
*/
|
|
4235
4560
|
Namespace: string | undefined;
|
|
4236
4561
|
}
|
|
4562
|
+
/**
|
|
4563
|
+
* @public
|
|
4564
|
+
*/
|
|
4237
4565
|
export interface DeleteIAMPolicyAssignmentResponse {
|
|
4238
4566
|
/**
|
|
4239
4567
|
* <p>The name of the assignment. </p>
|
|
@@ -4248,6 +4576,9 @@ export interface DeleteIAMPolicyAssignmentResponse {
|
|
|
4248
4576
|
*/
|
|
4249
4577
|
Status?: number;
|
|
4250
4578
|
}
|
|
4579
|
+
/**
|
|
4580
|
+
* @public
|
|
4581
|
+
*/
|
|
4251
4582
|
export interface DeleteNamespaceRequest {
|
|
4252
4583
|
/**
|
|
4253
4584
|
* <p>The ID for the Amazon Web Services account that you want to delete the Amazon QuickSight namespace from.</p>
|
|
@@ -4258,6 +4589,9 @@ export interface DeleteNamespaceRequest {
|
|
|
4258
4589
|
*/
|
|
4259
4590
|
Namespace: string | undefined;
|
|
4260
4591
|
}
|
|
4592
|
+
/**
|
|
4593
|
+
* @public
|
|
4594
|
+
*/
|
|
4261
4595
|
export interface DeleteNamespaceResponse {
|
|
4262
4596
|
/**
|
|
4263
4597
|
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
@@ -4268,6 +4602,9 @@ export interface DeleteNamespaceResponse {
|
|
|
4268
4602
|
*/
|
|
4269
4603
|
Status?: number;
|
|
4270
4604
|
}
|
|
4605
|
+
/**
|
|
4606
|
+
* @public
|
|
4607
|
+
*/
|
|
4271
4608
|
export interface DeleteTemplateRequest {
|
|
4272
4609
|
/**
|
|
4273
4610
|
* <p>The ID of the Amazon Web Services account that contains the template that you're deleting.</p>
|
|
@@ -4284,6 +4621,9 @@ export interface DeleteTemplateRequest {
|
|
|
4284
4621
|
*/
|
|
4285
4622
|
VersionNumber?: number;
|
|
4286
4623
|
}
|
|
4624
|
+
/**
|
|
4625
|
+
* @public
|
|
4626
|
+
*/
|
|
4287
4627
|
export interface DeleteTemplateResponse {
|
|
4288
4628
|
/**
|
|
4289
4629
|
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
@@ -4302,6 +4642,9 @@ export interface DeleteTemplateResponse {
|
|
|
4302
4642
|
*/
|
|
4303
4643
|
Status?: number;
|
|
4304
4644
|
}
|
|
4645
|
+
/**
|
|
4646
|
+
* @public
|
|
4647
|
+
*/
|
|
4305
4648
|
export interface DeleteTemplateAliasRequest {
|
|
4306
4649
|
/**
|
|
4307
4650
|
* <p>The ID of the Amazon Web Services account that contains the item to delete.</p>
|
|
@@ -4319,6 +4662,9 @@ export interface DeleteTemplateAliasRequest {
|
|
|
4319
4662
|
*/
|
|
4320
4663
|
AliasName: string | undefined;
|
|
4321
4664
|
}
|
|
4665
|
+
/**
|
|
4666
|
+
* @public
|
|
4667
|
+
*/
|
|
4322
4668
|
export interface DeleteTemplateAliasResponse {
|
|
4323
4669
|
/**
|
|
4324
4670
|
* <p>The HTTP status of the request.</p>
|
|
@@ -4341,6 +4687,9 @@ export interface DeleteTemplateAliasResponse {
|
|
|
4341
4687
|
*/
|
|
4342
4688
|
RequestId?: string;
|
|
4343
4689
|
}
|
|
4690
|
+
/**
|
|
4691
|
+
* @public
|
|
4692
|
+
*/
|
|
4344
4693
|
export interface DeleteThemeRequest {
|
|
4345
4694
|
/**
|
|
4346
4695
|
* <p>The ID of the Amazon Web Services account that contains the theme that you're deleting.</p>
|
|
@@ -4358,6 +4707,9 @@ export interface DeleteThemeRequest {
|
|
|
4358
4707
|
*/
|
|
4359
4708
|
VersionNumber?: number;
|
|
4360
4709
|
}
|
|
4710
|
+
/**
|
|
4711
|
+
* @public
|
|
4712
|
+
*/
|
|
4361
4713
|
export interface DeleteThemeResponse {
|
|
4362
4714
|
/**
|
|
4363
4715
|
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
@@ -4376,6 +4728,9 @@ export interface DeleteThemeResponse {
|
|
|
4376
4728
|
*/
|
|
4377
4729
|
ThemeId?: string;
|
|
4378
4730
|
}
|
|
4731
|
+
/**
|
|
4732
|
+
* @public
|
|
4733
|
+
*/
|
|
4379
4734
|
export interface DeleteThemeAliasRequest {
|
|
4380
4735
|
/**
|
|
4381
4736
|
* <p>The ID of the Amazon Web Services account that contains the theme alias to delete.</p>
|
|
@@ -4390,6 +4745,9 @@ export interface DeleteThemeAliasRequest {
|
|
|
4390
4745
|
*/
|
|
4391
4746
|
AliasName: string | undefined;
|
|
4392
4747
|
}
|
|
4748
|
+
/**
|
|
4749
|
+
* @public
|
|
4750
|
+
*/
|
|
4393
4751
|
export interface DeleteThemeAliasResponse {
|
|
4394
4752
|
/**
|
|
4395
4753
|
* <p>The name for the theme alias.</p>
|
|
@@ -4412,6 +4770,9 @@ export interface DeleteThemeAliasResponse {
|
|
|
4412
4770
|
*/
|
|
4413
4771
|
ThemeId?: string;
|
|
4414
4772
|
}
|
|
4773
|
+
/**
|
|
4774
|
+
* @public
|
|
4775
|
+
*/
|
|
4415
4776
|
export interface DeleteUserRequest {
|
|
4416
4777
|
/**
|
|
4417
4778
|
* <p>The name of the user that you want to delete.</p>
|
|
@@ -4427,6 +4788,9 @@ export interface DeleteUserRequest {
|
|
|
4427
4788
|
*/
|
|
4428
4789
|
Namespace: string | undefined;
|
|
4429
4790
|
}
|
|
4791
|
+
/**
|
|
4792
|
+
* @public
|
|
4793
|
+
*/
|
|
4430
4794
|
export interface DeleteUserResponse {
|
|
4431
4795
|
/**
|
|
4432
4796
|
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
@@ -4438,6 +4802,7 @@ export interface DeleteUserResponse {
|
|
|
4438
4802
|
Status?: number;
|
|
4439
4803
|
}
|
|
4440
4804
|
/**
|
|
4805
|
+
* @public
|
|
4441
4806
|
* <p></p>
|
|
4442
4807
|
*/
|
|
4443
4808
|
export interface DeleteUserByPrincipalIdRequest {
|
|
@@ -4455,6 +4820,9 @@ export interface DeleteUserByPrincipalIdRequest {
|
|
|
4455
4820
|
*/
|
|
4456
4821
|
Namespace: string | undefined;
|
|
4457
4822
|
}
|
|
4823
|
+
/**
|
|
4824
|
+
* @public
|
|
4825
|
+
*/
|
|
4458
4826
|
export interface DeleteUserByPrincipalIdResponse {
|
|
4459
4827
|
/**
|
|
4460
4828
|
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
@@ -4465,6 +4833,9 @@ export interface DeleteUserByPrincipalIdResponse {
|
|
|
4465
4833
|
*/
|
|
4466
4834
|
Status?: number;
|
|
4467
4835
|
}
|
|
4836
|
+
/**
|
|
4837
|
+
* @public
|
|
4838
|
+
*/
|
|
4468
4839
|
export interface DescribeAccountCustomizationRequest {
|
|
4469
4840
|
/**
|
|
4470
4841
|
* <p>The ID for the Amazon Web Services account that you want to describe Amazon QuickSight customizations
|
|
@@ -4485,6 +4856,9 @@ export interface DescribeAccountCustomizationRequest {
|
|
|
4485
4856
|
*/
|
|
4486
4857
|
Resolved?: boolean;
|
|
4487
4858
|
}
|
|
4859
|
+
/**
|
|
4860
|
+
* @public
|
|
4861
|
+
*/
|
|
4488
4862
|
export interface DescribeAccountCustomizationResponse {
|
|
4489
4863
|
/**
|
|
4490
4864
|
* <p>The Amazon Resource Name (ARN) of the customization that's associated with this Amazon Web Services account.</p>
|
|
@@ -4511,12 +4885,18 @@ export interface DescribeAccountCustomizationResponse {
|
|
|
4511
4885
|
*/
|
|
4512
4886
|
Status?: number;
|
|
4513
4887
|
}
|
|
4888
|
+
/**
|
|
4889
|
+
* @public
|
|
4890
|
+
*/
|
|
4514
4891
|
export interface DescribeAccountSettingsRequest {
|
|
4515
4892
|
/**
|
|
4516
4893
|
* <p>The ID for the Amazon Web Services account that contains the settings that you want to list.</p>
|
|
4517
4894
|
*/
|
|
4518
4895
|
AwsAccountId: string | undefined;
|
|
4519
4896
|
}
|
|
4897
|
+
/**
|
|
4898
|
+
* @public
|
|
4899
|
+
*/
|
|
4520
4900
|
export interface DescribeAccountSettingsResponse {
|
|
4521
4901
|
/**
|
|
4522
4902
|
* <p>The Amazon QuickSight settings for this Amazon Web Services account. This information
|
|
@@ -4537,12 +4917,18 @@ export interface DescribeAccountSettingsResponse {
|
|
|
4537
4917
|
*/
|
|
4538
4918
|
Status?: number;
|
|
4539
4919
|
}
|
|
4920
|
+
/**
|
|
4921
|
+
* @public
|
|
4922
|
+
*/
|
|
4540
4923
|
export interface DescribeAccountSubscriptionRequest {
|
|
4541
4924
|
/**
|
|
4542
4925
|
* <p>The Amazon Web Services account ID associated with your Amazon QuickSight account.</p>
|
|
4543
4926
|
*/
|
|
4544
4927
|
AwsAccountId: string | undefined;
|
|
4545
4928
|
}
|
|
4929
|
+
/**
|
|
4930
|
+
* @public
|
|
4931
|
+
*/
|
|
4546
4932
|
export interface DescribeAccountSubscriptionResponse {
|
|
4547
4933
|
/**
|
|
4548
4934
|
* <p>A structure that contains the following elements:</p>
|
|
@@ -4576,6 +4962,9 @@ export interface DescribeAccountSubscriptionResponse {
|
|
|
4576
4962
|
*/
|
|
4577
4963
|
RequestId?: string;
|
|
4578
4964
|
}
|
|
4965
|
+
/**
|
|
4966
|
+
* @public
|
|
4967
|
+
*/
|
|
4579
4968
|
export interface DescribeAnalysisRequest {
|
|
4580
4969
|
/**
|
|
4581
4970
|
* <p>The ID of the Amazon Web Services account that contains the analysis. You must be using the
|
|
@@ -4588,6 +4977,9 @@ export interface DescribeAnalysisRequest {
|
|
|
4588
4977
|
*/
|
|
4589
4978
|
AnalysisId: string | undefined;
|
|
4590
4979
|
}
|
|
4980
|
+
/**
|
|
4981
|
+
* @public
|
|
4982
|
+
*/
|
|
4591
4983
|
export interface DescribeAnalysisResponse {
|
|
4592
4984
|
/**
|
|
4593
4985
|
* <p>A metadata structure that contains summary information for the analysis that you're
|
|
@@ -4603,6 +4995,9 @@ export interface DescribeAnalysisResponse {
|
|
|
4603
4995
|
*/
|
|
4604
4996
|
RequestId?: string;
|
|
4605
4997
|
}
|
|
4998
|
+
/**
|
|
4999
|
+
* @public
|
|
5000
|
+
*/
|
|
4606
5001
|
export interface DescribeAnalysisDefinitionRequest {
|
|
4607
5002
|
/**
|
|
4608
5003
|
* <p>The ID of the Amazon Web Services account that contains the analysis. You must be using the
|
|
@@ -4615,6 +5010,9 @@ export interface DescribeAnalysisDefinitionRequest {
|
|
|
4615
5010
|
*/
|
|
4616
5011
|
AnalysisId: string | undefined;
|
|
4617
5012
|
}
|
|
5013
|
+
/**
|
|
5014
|
+
* @public
|
|
5015
|
+
*/
|
|
4618
5016
|
export interface DescribeAnalysisDefinitionResponse {
|
|
4619
5017
|
/**
|
|
4620
5018
|
* <p>The ID of the analysis described.</p>
|
|
@@ -4687,6 +5085,9 @@ export interface DescribeAnalysisDefinitionResponse {
|
|
|
4687
5085
|
*/
|
|
4688
5086
|
RequestId?: string;
|
|
4689
5087
|
}
|
|
5088
|
+
/**
|
|
5089
|
+
* @public
|
|
5090
|
+
*/
|
|
4690
5091
|
export interface DescribeAnalysisPermissionsRequest {
|
|
4691
5092
|
/**
|
|
4692
5093
|
* <p>The ID of the Amazon Web Services account that contains the analysis whose permissions you're
|
|
@@ -4699,6 +5100,9 @@ export interface DescribeAnalysisPermissionsRequest {
|
|
|
4699
5100
|
*/
|
|
4700
5101
|
AnalysisId: string | undefined;
|
|
4701
5102
|
}
|
|
5103
|
+
/**
|
|
5104
|
+
* @public
|
|
5105
|
+
*/
|
|
4702
5106
|
export interface DescribeAnalysisPermissionsResponse {
|
|
4703
5107
|
/**
|
|
4704
5108
|
* <p>The ID of the analysis whose permissions you're describing.</p>
|
|
@@ -4723,6 +5127,9 @@ export interface DescribeAnalysisPermissionsResponse {
|
|
|
4723
5127
|
*/
|
|
4724
5128
|
RequestId?: string;
|
|
4725
5129
|
}
|
|
5130
|
+
/**
|
|
5131
|
+
* @public
|
|
5132
|
+
*/
|
|
4726
5133
|
export interface DescribeDashboardRequest {
|
|
4727
5134
|
/**
|
|
4728
5135
|
* <p>The ID of the Amazon Web Services account that contains the dashboard that you're
|
|
@@ -4743,6 +5150,9 @@ export interface DescribeDashboardRequest {
|
|
|
4743
5150
|
*/
|
|
4744
5151
|
AliasName?: string;
|
|
4745
5152
|
}
|
|
5153
|
+
/**
|
|
5154
|
+
* @public
|
|
5155
|
+
*/
|
|
4746
5156
|
export interface DescribeDashboardResponse {
|
|
4747
5157
|
/**
|
|
4748
5158
|
* <p>Information about the dashboard.</p>
|
|
@@ -4757,6 +5167,9 @@ export interface DescribeDashboardResponse {
|
|
|
4757
5167
|
*/
|
|
4758
5168
|
RequestId?: string;
|
|
4759
5169
|
}
|
|
5170
|
+
/**
|
|
5171
|
+
* @public
|
|
5172
|
+
*/
|
|
4760
5173
|
export interface DescribeDashboardDefinitionRequest {
|
|
4761
5174
|
/**
|
|
4762
5175
|
* <p>The ID of the Amazon Web Services account that contains the dashboard that you're
|
|
@@ -4777,6 +5190,9 @@ export interface DescribeDashboardDefinitionRequest {
|
|
|
4777
5190
|
*/
|
|
4778
5191
|
AliasName?: string;
|
|
4779
5192
|
}
|
|
5193
|
+
/**
|
|
5194
|
+
* @public
|
|
5195
|
+
*/
|
|
4780
5196
|
export interface DescribeDashboardDefinitionResponse {
|
|
4781
5197
|
/**
|
|
4782
5198
|
* <p>The ID of the dashboard described.</p>
|
|
@@ -4876,6 +5292,9 @@ export interface DescribeDashboardDefinitionResponse {
|
|
|
4876
5292
|
*/
|
|
4877
5293
|
DashboardPublishOptions?: DashboardPublishOptions;
|
|
4878
5294
|
}
|
|
5295
|
+
/**
|
|
5296
|
+
* @public
|
|
5297
|
+
*/
|
|
4879
5298
|
export interface DescribeDashboardPermissionsRequest {
|
|
4880
5299
|
/**
|
|
4881
5300
|
* <p>The ID of the Amazon Web Services account that contains the dashboard that you're describing
|
|
@@ -4888,6 +5307,7 @@ export interface DescribeDashboardPermissionsRequest {
|
|
|
4888
5307
|
DashboardId: string | undefined;
|
|
4889
5308
|
}
|
|
4890
5309
|
/**
|
|
5310
|
+
* @public
|
|
4891
5311
|
* <p>A structure that contains the configuration of a shareable link to the dashboard.</p>
|
|
4892
5312
|
*/
|
|
4893
5313
|
export interface LinkSharingConfiguration {
|
|
@@ -4896,6 +5316,9 @@ export interface LinkSharingConfiguration {
|
|
|
4896
5316
|
*/
|
|
4897
5317
|
Permissions?: ResourcePermission[];
|
|
4898
5318
|
}
|
|
5319
|
+
/**
|
|
5320
|
+
* @public
|
|
5321
|
+
*/
|
|
4899
5322
|
export interface DescribeDashboardPermissionsResponse {
|
|
4900
5323
|
/**
|
|
4901
5324
|
* <p>The ID for the dashboard.</p>
|
|
@@ -4925,6 +5348,9 @@ export interface DescribeDashboardPermissionsResponse {
|
|
|
4925
5348
|
*/
|
|
4926
5349
|
LinkSharingConfiguration?: LinkSharingConfiguration;
|
|
4927
5350
|
}
|
|
5351
|
+
/**
|
|
5352
|
+
* @public
|
|
5353
|
+
*/
|
|
4928
5354
|
export interface DescribeDataSetRequest {
|
|
4929
5355
|
/**
|
|
4930
5356
|
* <p>The Amazon Web Services account ID.</p>
|
|
@@ -4935,6 +5361,9 @@ export interface DescribeDataSetRequest {
|
|
|
4935
5361
|
*/
|
|
4936
5362
|
DataSetId: string | undefined;
|
|
4937
5363
|
}
|
|
5364
|
+
/**
|
|
5365
|
+
* @public
|
|
5366
|
+
*/
|
|
4938
5367
|
export interface DescribeDataSetResponse {
|
|
4939
5368
|
/**
|
|
4940
5369
|
* <p>Information on the dataset.</p>
|
|
@@ -4949,6 +5378,9 @@ export interface DescribeDataSetResponse {
|
|
|
4949
5378
|
*/
|
|
4950
5379
|
Status?: number;
|
|
4951
5380
|
}
|
|
5381
|
+
/**
|
|
5382
|
+
* @public
|
|
5383
|
+
*/
|
|
4952
5384
|
export interface DescribeDataSetPermissionsRequest {
|
|
4953
5385
|
/**
|
|
4954
5386
|
* <p>The Amazon Web Services account ID.</p>
|
|
@@ -4959,6 +5391,9 @@ export interface DescribeDataSetPermissionsRequest {
|
|
|
4959
5391
|
*/
|
|
4960
5392
|
DataSetId: string | undefined;
|
|
4961
5393
|
}
|
|
5394
|
+
/**
|
|
5395
|
+
* @public
|
|
5396
|
+
*/
|
|
4962
5397
|
export interface DescribeDataSetPermissionsResponse {
|
|
4963
5398
|
/**
|
|
4964
5399
|
* <p>The Amazon Resource Name (ARN) of the dataset.</p>
|
|
@@ -4981,6 +5416,9 @@ export interface DescribeDataSetPermissionsResponse {
|
|
|
4981
5416
|
*/
|
|
4982
5417
|
Status?: number;
|
|
4983
5418
|
}
|
|
5419
|
+
/**
|
|
5420
|
+
* @public
|
|
5421
|
+
*/
|
|
4984
5422
|
export interface DescribeDataSourceRequest {
|
|
4985
5423
|
/**
|
|
4986
5424
|
* <p>The Amazon Web Services account ID.</p>
|
|
@@ -4991,6 +5429,9 @@ export interface DescribeDataSourceRequest {
|
|
|
4991
5429
|
*/
|
|
4992
5430
|
DataSourceId: string | undefined;
|
|
4993
5431
|
}
|
|
5432
|
+
/**
|
|
5433
|
+
* @public
|
|
5434
|
+
*/
|
|
4994
5435
|
export interface DescribeDataSourceResponse {
|
|
4995
5436
|
/**
|
|
4996
5437
|
* <p>The information on the data source.</p>
|
|
@@ -5005,6 +5446,9 @@ export interface DescribeDataSourceResponse {
|
|
|
5005
5446
|
*/
|
|
5006
5447
|
Status?: number;
|
|
5007
5448
|
}
|
|
5449
|
+
/**
|
|
5450
|
+
* @public
|
|
5451
|
+
*/
|
|
5008
5452
|
export interface DescribeDataSourcePermissionsRequest {
|
|
5009
5453
|
/**
|
|
5010
5454
|
* <p>The Amazon Web Services account ID.</p>
|
|
@@ -5015,6 +5459,9 @@ export interface DescribeDataSourcePermissionsRequest {
|
|
|
5015
5459
|
*/
|
|
5016
5460
|
DataSourceId: string | undefined;
|
|
5017
5461
|
}
|
|
5462
|
+
/**
|
|
5463
|
+
* @public
|
|
5464
|
+
*/
|
|
5018
5465
|
export interface DescribeDataSourcePermissionsResponse {
|
|
5019
5466
|
/**
|
|
5020
5467
|
* <p>The Amazon Resource Name (ARN) of the data source.</p>
|
|
@@ -5037,6 +5484,9 @@ export interface DescribeDataSourcePermissionsResponse {
|
|
|
5037
5484
|
*/
|
|
5038
5485
|
Status?: number;
|
|
5039
5486
|
}
|
|
5487
|
+
/**
|
|
5488
|
+
* @public
|
|
5489
|
+
*/
|
|
5040
5490
|
export interface DescribeFolderRequest {
|
|
5041
5491
|
/**
|
|
5042
5492
|
* <p>The ID for the Amazon Web Services account that contains the folder.</p>
|
|
@@ -5048,6 +5498,7 @@ export interface DescribeFolderRequest {
|
|
|
5048
5498
|
FolderId: string | undefined;
|
|
5049
5499
|
}
|
|
5050
5500
|
/**
|
|
5501
|
+
* @public
|
|
5051
5502
|
* <p>A folder in Amazon QuickSight.</p>
|
|
5052
5503
|
*/
|
|
5053
5504
|
export interface Folder {
|
|
@@ -5080,6 +5531,9 @@ export interface Folder {
|
|
|
5080
5531
|
*/
|
|
5081
5532
|
LastUpdatedTime?: Date;
|
|
5082
5533
|
}
|
|
5534
|
+
/**
|
|
5535
|
+
* @public
|
|
5536
|
+
*/
|
|
5083
5537
|
export interface DescribeFolderResponse {
|
|
5084
5538
|
/**
|
|
5085
5539
|
* <p>The HTTP status of the request.</p>
|
|
@@ -5094,6 +5548,9 @@ export interface DescribeFolderResponse {
|
|
|
5094
5548
|
*/
|
|
5095
5549
|
RequestId?: string;
|
|
5096
5550
|
}
|
|
5551
|
+
/**
|
|
5552
|
+
* @public
|
|
5553
|
+
*/
|
|
5097
5554
|
export interface DescribeFolderPermissionsRequest {
|
|
5098
5555
|
/**
|
|
5099
5556
|
* <p>The ID for the Amazon Web Services account that contains the folder.</p>
|
|
@@ -5104,6 +5561,9 @@ export interface DescribeFolderPermissionsRequest {
|
|
|
5104
5561
|
*/
|
|
5105
5562
|
FolderId: string | undefined;
|
|
5106
5563
|
}
|
|
5564
|
+
/**
|
|
5565
|
+
* @public
|
|
5566
|
+
*/
|
|
5107
5567
|
export interface DescribeFolderPermissionsResponse {
|
|
5108
5568
|
/**
|
|
5109
5569
|
* <p>The HTTP status of the request.</p>
|
|
@@ -5126,6 +5586,9 @@ export interface DescribeFolderPermissionsResponse {
|
|
|
5126
5586
|
*/
|
|
5127
5587
|
RequestId?: string;
|
|
5128
5588
|
}
|
|
5589
|
+
/**
|
|
5590
|
+
* @public
|
|
5591
|
+
*/
|
|
5129
5592
|
export interface DescribeFolderResolvedPermissionsRequest {
|
|
5130
5593
|
/**
|
|
5131
5594
|
* <p>The ID for the Amazon Web Services account that contains the folder.</p>
|
|
@@ -5136,6 +5599,9 @@ export interface DescribeFolderResolvedPermissionsRequest {
|
|
|
5136
5599
|
*/
|
|
5137
5600
|
FolderId: string | undefined;
|
|
5138
5601
|
}
|
|
5602
|
+
/**
|
|
5603
|
+
* @public
|
|
5604
|
+
*/
|
|
5139
5605
|
export interface DescribeFolderResolvedPermissionsResponse {
|
|
5140
5606
|
/**
|
|
5141
5607
|
* <p>The HTTP status of the request.</p>
|
|
@@ -5158,6 +5624,9 @@ export interface DescribeFolderResolvedPermissionsResponse {
|
|
|
5158
5624
|
*/
|
|
5159
5625
|
RequestId?: string;
|
|
5160
5626
|
}
|
|
5627
|
+
/**
|
|
5628
|
+
* @public
|
|
5629
|
+
*/
|
|
5161
5630
|
export interface DescribeGroupRequest {
|
|
5162
5631
|
/**
|
|
5163
5632
|
* <p>The name of the group that you want to describe.</p>
|
|
@@ -5173,6 +5642,9 @@ export interface DescribeGroupRequest {
|
|
|
5173
5642
|
*/
|
|
5174
5643
|
Namespace: string | undefined;
|
|
5175
5644
|
}
|
|
5645
|
+
/**
|
|
5646
|
+
* @public
|
|
5647
|
+
*/
|
|
5176
5648
|
export interface DescribeGroupResponse {
|
|
5177
5649
|
/**
|
|
5178
5650
|
* <p>The name of the group.</p>
|
|
@@ -5187,6 +5659,9 @@ export interface DescribeGroupResponse {
|
|
|
5187
5659
|
*/
|
|
5188
5660
|
Status?: number;
|
|
5189
5661
|
}
|
|
5662
|
+
/**
|
|
5663
|
+
* @public
|
|
5664
|
+
*/
|
|
5190
5665
|
export interface DescribeGroupMembershipRequest {
|
|
5191
5666
|
/**
|
|
5192
5667
|
* <p>The user name of the user that you want to search for.</p>
|
|
@@ -5206,6 +5681,9 @@ export interface DescribeGroupMembershipRequest {
|
|
|
5206
5681
|
*/
|
|
5207
5682
|
Namespace: string | undefined;
|
|
5208
5683
|
}
|
|
5684
|
+
/**
|
|
5685
|
+
* @public
|
|
5686
|
+
*/
|
|
5209
5687
|
export interface DescribeGroupMembershipResponse {
|
|
5210
5688
|
/**
|
|
5211
5689
|
* <p>A member of an Amazon QuickSight group. Currently, group members must be users. Groups
|
|
@@ -5221,6 +5699,9 @@ export interface DescribeGroupMembershipResponse {
|
|
|
5221
5699
|
*/
|
|
5222
5700
|
Status?: number;
|
|
5223
5701
|
}
|
|
5702
|
+
/**
|
|
5703
|
+
* @public
|
|
5704
|
+
*/
|
|
5224
5705
|
export interface DescribeIAMPolicyAssignmentRequest {
|
|
5225
5706
|
/**
|
|
5226
5707
|
* <p>The ID of the Amazon Web Services account that contains the assignment that you want to describe.</p>
|
|
@@ -5236,6 +5717,7 @@ export interface DescribeIAMPolicyAssignmentRequest {
|
|
|
5236
5717
|
Namespace: string | undefined;
|
|
5237
5718
|
}
|
|
5238
5719
|
/**
|
|
5720
|
+
* @public
|
|
5239
5721
|
* <p>An Identity and Access Management (IAM) policy assignment.</p>
|
|
5240
5722
|
*/
|
|
5241
5723
|
export interface IAMPolicyAssignment {
|
|
@@ -5264,6 +5746,9 @@ export interface IAMPolicyAssignment {
|
|
|
5264
5746
|
*/
|
|
5265
5747
|
AssignmentStatus?: AssignmentStatus | string;
|
|
5266
5748
|
}
|
|
5749
|
+
/**
|
|
5750
|
+
* @public
|
|
5751
|
+
*/
|
|
5267
5752
|
export interface DescribeIAMPolicyAssignmentResponse {
|
|
5268
5753
|
/**
|
|
5269
5754
|
* <p>Information describing the IAM policy assignment.</p>
|
|
@@ -5279,6 +5764,7 @@ export interface DescribeIAMPolicyAssignmentResponse {
|
|
|
5279
5764
|
Status?: number;
|
|
5280
5765
|
}
|
|
5281
5766
|
/**
|
|
5767
|
+
* @public
|
|
5282
5768
|
* <p>The <code>NextToken</code> value isn't valid.</p>
|
|
5283
5769
|
*/
|
|
5284
5770
|
export declare class InvalidNextTokenException extends __BaseException {
|
|
@@ -5294,6 +5780,9 @@ export declare class InvalidNextTokenException extends __BaseException {
|
|
|
5294
5780
|
*/
|
|
5295
5781
|
constructor(opts: __ExceptionOptionType<InvalidNextTokenException, __BaseException>);
|
|
5296
5782
|
}
|
|
5783
|
+
/**
|
|
5784
|
+
* @public
|
|
5785
|
+
*/
|
|
5297
5786
|
export interface DescribeIngestionRequest {
|
|
5298
5787
|
/**
|
|
5299
5788
|
* <p>The Amazon Web Services account ID.</p>
|
|
@@ -5308,6 +5797,9 @@ export interface DescribeIngestionRequest {
|
|
|
5308
5797
|
*/
|
|
5309
5798
|
IngestionId: string | undefined;
|
|
5310
5799
|
}
|
|
5800
|
+
/**
|
|
5801
|
+
* @public
|
|
5802
|
+
*/
|
|
5311
5803
|
export declare enum IngestionErrorType {
|
|
5312
5804
|
ACCOUNT_CAPACITY_LIMIT_EXCEEDED = "ACCOUNT_CAPACITY_LIMIT_EXCEEDED",
|
|
5313
5805
|
CONNECTION_FAILURE = "CONNECTION_FAILURE",
|
|
@@ -5355,6 +5847,7 @@ export declare enum IngestionErrorType {
|
|
|
5355
5847
|
UNROUTABLE_HOST = "UNROUTABLE_HOST"
|
|
5356
5848
|
}
|
|
5357
5849
|
/**
|
|
5850
|
+
* @public
|
|
5358
5851
|
* <p>Error information for the SPICE ingestion of a dataset.</p>
|
|
5359
5852
|
*/
|
|
5360
5853
|
export interface ErrorInfo {
|
|
@@ -5368,6 +5861,7 @@ export interface ErrorInfo {
|
|
|
5368
5861
|
Message?: string;
|
|
5369
5862
|
}
|
|
5370
5863
|
/**
|
|
5864
|
+
* @public
|
|
5371
5865
|
* <p>Information about a queued dataset SPICE ingestion.</p>
|
|
5372
5866
|
*/
|
|
5373
5867
|
export interface QueueInfo {
|
|
@@ -5381,10 +5875,16 @@ export interface QueueInfo {
|
|
|
5381
5875
|
*/
|
|
5382
5876
|
QueuedIngestion: string | undefined;
|
|
5383
5877
|
}
|
|
5878
|
+
/**
|
|
5879
|
+
* @public
|
|
5880
|
+
*/
|
|
5384
5881
|
export declare enum IngestionRequestSource {
|
|
5385
5882
|
MANUAL = "MANUAL",
|
|
5386
5883
|
SCHEDULED = "SCHEDULED"
|
|
5387
5884
|
}
|
|
5885
|
+
/**
|
|
5886
|
+
* @public
|
|
5887
|
+
*/
|
|
5388
5888
|
export declare enum IngestionRequestType {
|
|
5389
5889
|
EDIT = "EDIT",
|
|
5390
5890
|
FULL_REFRESH = "FULL_REFRESH",
|
|
@@ -5392,6 +5892,7 @@ export declare enum IngestionRequestType {
|
|
|
5392
5892
|
INITIAL_INGESTION = "INITIAL_INGESTION"
|
|
5393
5893
|
}
|
|
5394
5894
|
/**
|
|
5895
|
+
* @public
|
|
5395
5896
|
* <p>Information about rows for a data set SPICE ingestion.</p>
|
|
5396
5897
|
*/
|
|
5397
5898
|
export interface RowInfo {
|
|
@@ -5409,6 +5910,7 @@ export interface RowInfo {
|
|
|
5409
5910
|
TotalRowsInDataset?: number;
|
|
5410
5911
|
}
|
|
5411
5912
|
/**
|
|
5913
|
+
* @public
|
|
5412
5914
|
* <p>Information about the SPICE ingestion for a dataset.</p>
|
|
5413
5915
|
*/
|
|
5414
5916
|
export interface Ingestion {
|
|
@@ -5457,6 +5959,9 @@ export interface Ingestion {
|
|
|
5457
5959
|
*/
|
|
5458
5960
|
RequestType?: IngestionRequestType | string;
|
|
5459
5961
|
}
|
|
5962
|
+
/**
|
|
5963
|
+
* @public
|
|
5964
|
+
*/
|
|
5460
5965
|
export interface DescribeIngestionResponse {
|
|
5461
5966
|
/**
|
|
5462
5967
|
* <p>Information about the ingestion.</p>
|
|
@@ -5471,12 +5976,18 @@ export interface DescribeIngestionResponse {
|
|
|
5471
5976
|
*/
|
|
5472
5977
|
Status?: number;
|
|
5473
5978
|
}
|
|
5979
|
+
/**
|
|
5980
|
+
* @public
|
|
5981
|
+
*/
|
|
5474
5982
|
export interface DescribeIpRestrictionRequest {
|
|
5475
5983
|
/**
|
|
5476
5984
|
* <p>The ID of the Amazon Web Services account that contains the IP rules.</p>
|
|
5477
5985
|
*/
|
|
5478
5986
|
AwsAccountId: string | undefined;
|
|
5479
5987
|
}
|
|
5988
|
+
/**
|
|
5989
|
+
* @public
|
|
5990
|
+
*/
|
|
5480
5991
|
export interface DescribeIpRestrictionResponse {
|
|
5481
5992
|
/**
|
|
5482
5993
|
* <p>The ID of the Amazon Web Services account that contains the IP rules.</p>
|
|
@@ -5499,6 +6010,9 @@ export interface DescribeIpRestrictionResponse {
|
|
|
5499
6010
|
*/
|
|
5500
6011
|
Status?: number;
|
|
5501
6012
|
}
|
|
6013
|
+
/**
|
|
6014
|
+
* @public
|
|
6015
|
+
*/
|
|
5502
6016
|
export interface DescribeNamespaceRequest {
|
|
5503
6017
|
/**
|
|
5504
6018
|
* <p>The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.</p>
|
|
@@ -5509,11 +6023,15 @@ export interface DescribeNamespaceRequest {
|
|
|
5509
6023
|
*/
|
|
5510
6024
|
Namespace: string | undefined;
|
|
5511
6025
|
}
|
|
6026
|
+
/**
|
|
6027
|
+
* @public
|
|
6028
|
+
*/
|
|
5512
6029
|
export declare enum NamespaceErrorType {
|
|
5513
6030
|
INTERNAL_SERVICE_ERROR = "INTERNAL_SERVICE_ERROR",
|
|
5514
6031
|
PERMISSION_DENIED = "PERMISSION_DENIED"
|
|
5515
6032
|
}
|
|
5516
6033
|
/**
|
|
6034
|
+
* @public
|
|
5517
6035
|
* <p>Errors that occur during namespace creation.</p>
|
|
5518
6036
|
*/
|
|
5519
6037
|
export interface NamespaceError {
|
|
@@ -5527,6 +6045,7 @@ export interface NamespaceError {
|
|
|
5527
6045
|
Message?: string;
|
|
5528
6046
|
}
|
|
5529
6047
|
/**
|
|
6048
|
+
* @public
|
|
5530
6049
|
* <p>The error type.</p>
|
|
5531
6050
|
*/
|
|
5532
6051
|
export interface NamespaceInfoV2 {
|
|
@@ -5555,6 +6074,9 @@ export interface NamespaceInfoV2 {
|
|
|
5555
6074
|
*/
|
|
5556
6075
|
NamespaceError?: NamespaceError;
|
|
5557
6076
|
}
|
|
6077
|
+
/**
|
|
6078
|
+
* @public
|
|
6079
|
+
*/
|
|
5558
6080
|
export interface DescribeNamespaceResponse {
|
|
5559
6081
|
/**
|
|
5560
6082
|
* <p>The information about the namespace that you're describing. The response includes
|
|
@@ -5572,6 +6094,9 @@ export interface DescribeNamespaceResponse {
|
|
|
5572
6094
|
*/
|
|
5573
6095
|
Status?: number;
|
|
5574
6096
|
}
|
|
6097
|
+
/**
|
|
6098
|
+
* @public
|
|
6099
|
+
*/
|
|
5575
6100
|
export interface DescribeTemplateRequest {
|
|
5576
6101
|
/**
|
|
5577
6102
|
* <p>The ID of the Amazon Web Services account that contains the template that you're describing.</p>
|
|
@@ -5594,6 +6119,9 @@ export interface DescribeTemplateRequest {
|
|
|
5594
6119
|
*/
|
|
5595
6120
|
AliasName?: string;
|
|
5596
6121
|
}
|
|
6122
|
+
/**
|
|
6123
|
+
* @public
|
|
6124
|
+
*/
|
|
5597
6125
|
export declare enum TemplateErrorType {
|
|
5598
6126
|
ACCESS_DENIED = "ACCESS_DENIED",
|
|
5599
6127
|
DATA_SET_NOT_FOUND = "DATA_SET_NOT_FOUND",
|
|
@@ -5601,6 +6129,7 @@ export declare enum TemplateErrorType {
|
|
|
5601
6129
|
SOURCE_NOT_FOUND = "SOURCE_NOT_FOUND"
|
|
5602
6130
|
}
|
|
5603
6131
|
/**
|
|
6132
|
+
* @public
|
|
5604
6133
|
* <p>List of errors that occurred when the template version creation failed.</p>
|
|
5605
6134
|
*/
|
|
5606
6135
|
export interface TemplateError {
|
|
@@ -5618,6 +6147,7 @@ export interface TemplateError {
|
|
|
5618
6147
|
ViolatedEntities?: Entity[];
|
|
5619
6148
|
}
|
|
5620
6149
|
/**
|
|
6150
|
+
* @public
|
|
5621
6151
|
* <p>A version of a template.</p>
|
|
5622
6152
|
*/
|
|
5623
6153
|
export interface TemplateVersion {
|
|
@@ -5699,6 +6229,7 @@ export interface TemplateVersion {
|
|
|
5699
6229
|
Sheets?: Sheet[];
|
|
5700
6230
|
}
|
|
5701
6231
|
/**
|
|
6232
|
+
* @public
|
|
5702
6233
|
* <p>A template object. A <i>template</i> is an entity in Amazon QuickSight that
|
|
5703
6234
|
* encapsulates the metadata required to create an analysis and that you can use to create
|
|
5704
6235
|
* a dashboard. A template adds a layer of abstraction by using placeholders to replace the
|
|
@@ -5734,6 +6265,9 @@ export interface Template {
|
|
|
5734
6265
|
*/
|
|
5735
6266
|
CreatedTime?: Date;
|
|
5736
6267
|
}
|
|
6268
|
+
/**
|
|
6269
|
+
* @public
|
|
6270
|
+
*/
|
|
5737
6271
|
export interface DescribeTemplateResponse {
|
|
5738
6272
|
/**
|
|
5739
6273
|
* <p>The template structure for the object you want to describe.</p>
|
|
@@ -5748,6 +6282,9 @@ export interface DescribeTemplateResponse {
|
|
|
5748
6282
|
*/
|
|
5749
6283
|
RequestId?: string;
|
|
5750
6284
|
}
|
|
6285
|
+
/**
|
|
6286
|
+
* @public
|
|
6287
|
+
*/
|
|
5751
6288
|
export interface DescribeTemplateAliasRequest {
|
|
5752
6289
|
/**
|
|
5753
6290
|
* <p>The ID of the Amazon Web Services account that contains the template alias that you're
|
|
@@ -5766,6 +6303,9 @@ export interface DescribeTemplateAliasRequest {
|
|
|
5766
6303
|
*/
|
|
5767
6304
|
AliasName: string | undefined;
|
|
5768
6305
|
}
|
|
6306
|
+
/**
|
|
6307
|
+
* @public
|
|
6308
|
+
*/
|
|
5769
6309
|
export interface DescribeTemplateAliasResponse {
|
|
5770
6310
|
/**
|
|
5771
6311
|
* <p>Information about the template alias.</p>
|
|
@@ -5780,6 +6320,9 @@ export interface DescribeTemplateAliasResponse {
|
|
|
5780
6320
|
*/
|
|
5781
6321
|
RequestId?: string;
|
|
5782
6322
|
}
|
|
6323
|
+
/**
|
|
6324
|
+
* @public
|
|
6325
|
+
*/
|
|
5783
6326
|
export interface DescribeTemplateDefinitionRequest {
|
|
5784
6327
|
/**
|
|
5785
6328
|
* <p>The ID of the Amazon Web Services account that contains the template. You must be using the
|
|
@@ -5802,6 +6345,9 @@ export interface DescribeTemplateDefinitionRequest {
|
|
|
5802
6345
|
*/
|
|
5803
6346
|
AliasName?: string;
|
|
5804
6347
|
}
|
|
6348
|
+
/**
|
|
6349
|
+
* @public
|
|
6350
|
+
*/
|
|
5805
6351
|
export interface DescribeTemplateDefinitionResponse {
|
|
5806
6352
|
/**
|
|
5807
6353
|
* <p>The descriptive name of the template.</p>
|
|
@@ -5874,6 +6420,9 @@ export interface DescribeTemplateDefinitionResponse {
|
|
|
5874
6420
|
*/
|
|
5875
6421
|
RequestId?: string;
|
|
5876
6422
|
}
|
|
6423
|
+
/**
|
|
6424
|
+
* @public
|
|
6425
|
+
*/
|
|
5877
6426
|
export interface DescribeTemplatePermissionsRequest {
|
|
5878
6427
|
/**
|
|
5879
6428
|
* <p>The ID of the Amazon Web Services account that contains the template that you're describing.</p>
|
|
@@ -5884,6 +6433,9 @@ export interface DescribeTemplatePermissionsRequest {
|
|
|
5884
6433
|
*/
|
|
5885
6434
|
TemplateId: string | undefined;
|
|
5886
6435
|
}
|
|
6436
|
+
/**
|
|
6437
|
+
* @public
|
|
6438
|
+
*/
|
|
5887
6439
|
export interface DescribeTemplatePermissionsResponse {
|
|
5888
6440
|
/**
|
|
5889
6441
|
* <p>The ID for the template.</p>
|
|
@@ -5906,6 +6458,9 @@ export interface DescribeTemplatePermissionsResponse {
|
|
|
5906
6458
|
*/
|
|
5907
6459
|
Status?: number;
|
|
5908
6460
|
}
|
|
6461
|
+
/**
|
|
6462
|
+
* @public
|
|
6463
|
+
*/
|
|
5909
6464
|
export interface DescribeThemeRequest {
|
|
5910
6465
|
/**
|
|
5911
6466
|
* <p>The ID of the Amazon Web Services account that contains the theme that you're describing.</p>
|
|
@@ -5928,15 +6483,22 @@ export interface DescribeThemeRequest {
|
|
|
5928
6483
|
*/
|
|
5929
6484
|
AliasName?: string;
|
|
5930
6485
|
}
|
|
6486
|
+
/**
|
|
6487
|
+
* @public
|
|
6488
|
+
*/
|
|
5931
6489
|
export declare enum ThemeType {
|
|
5932
6490
|
ALL = "ALL",
|
|
5933
6491
|
CUSTOM = "CUSTOM",
|
|
5934
6492
|
QUICKSIGHT = "QUICKSIGHT"
|
|
5935
6493
|
}
|
|
6494
|
+
/**
|
|
6495
|
+
* @public
|
|
6496
|
+
*/
|
|
5936
6497
|
export declare enum ThemeErrorType {
|
|
5937
6498
|
INTERNAL_FAILURE = "INTERNAL_FAILURE"
|
|
5938
6499
|
}
|
|
5939
6500
|
/**
|
|
6501
|
+
* @public
|
|
5940
6502
|
* <p>Theme error.</p>
|
|
5941
6503
|
*/
|
|
5942
6504
|
export interface ThemeError {
|
|
@@ -5950,6 +6512,7 @@ export interface ThemeError {
|
|
|
5950
6512
|
Message?: string;
|
|
5951
6513
|
}
|
|
5952
6514
|
/**
|
|
6515
|
+
* @public
|
|
5953
6516
|
* <p>A version of a theme.</p>
|
|
5954
6517
|
*/
|
|
5955
6518
|
export interface ThemeVersion {
|
|
@@ -5988,6 +6551,7 @@ export interface ThemeVersion {
|
|
|
5988
6551
|
Status?: ResourceStatus | string;
|
|
5989
6552
|
}
|
|
5990
6553
|
/**
|
|
6554
|
+
* @public
|
|
5991
6555
|
* <p>Summary information about a theme.</p>
|
|
5992
6556
|
*/
|
|
5993
6557
|
export interface Theme {
|
|
@@ -6021,6 +6585,9 @@ export interface Theme {
|
|
|
6021
6585
|
*/
|
|
6022
6586
|
Type?: ThemeType | string;
|
|
6023
6587
|
}
|
|
6588
|
+
/**
|
|
6589
|
+
* @public
|
|
6590
|
+
*/
|
|
6024
6591
|
export interface DescribeThemeResponse {
|
|
6025
6592
|
/**
|
|
6026
6593
|
* <p>The information about the theme that you are describing.</p>
|
|
@@ -6035,6 +6602,9 @@ export interface DescribeThemeResponse {
|
|
|
6035
6602
|
*/
|
|
6036
6603
|
RequestId?: string;
|
|
6037
6604
|
}
|
|
6605
|
+
/**
|
|
6606
|
+
* @public
|
|
6607
|
+
*/
|
|
6038
6608
|
export interface DescribeThemeAliasRequest {
|
|
6039
6609
|
/**
|
|
6040
6610
|
* <p>The ID of the Amazon Web Services account that contains the theme alias that you're
|
|
@@ -6050,6 +6620,9 @@ export interface DescribeThemeAliasRequest {
|
|
|
6050
6620
|
*/
|
|
6051
6621
|
AliasName: string | undefined;
|
|
6052
6622
|
}
|
|
6623
|
+
/**
|
|
6624
|
+
* @public
|
|
6625
|
+
*/
|
|
6053
6626
|
export interface DescribeThemeAliasResponse {
|
|
6054
6627
|
/**
|
|
6055
6628
|
* <p>Information about the theme alias.</p>
|
|
@@ -6064,6 +6637,9 @@ export interface DescribeThemeAliasResponse {
|
|
|
6064
6637
|
*/
|
|
6065
6638
|
RequestId?: string;
|
|
6066
6639
|
}
|
|
6640
|
+
/**
|
|
6641
|
+
* @public
|
|
6642
|
+
*/
|
|
6067
6643
|
export interface DescribeThemePermissionsRequest {
|
|
6068
6644
|
/**
|
|
6069
6645
|
* <p>The ID of the Amazon Web Services account that contains the theme that you're describing.</p>
|
|
@@ -6074,6 +6650,9 @@ export interface DescribeThemePermissionsRequest {
|
|
|
6074
6650
|
*/
|
|
6075
6651
|
ThemeId: string | undefined;
|
|
6076
6652
|
}
|
|
6653
|
+
/**
|
|
6654
|
+
* @public
|
|
6655
|
+
*/
|
|
6077
6656
|
export interface DescribeThemePermissionsResponse {
|
|
6078
6657
|
/**
|
|
6079
6658
|
* <p>The ID for the theme.</p>
|
|
@@ -6096,6 +6675,9 @@ export interface DescribeThemePermissionsResponse {
|
|
|
6096
6675
|
*/
|
|
6097
6676
|
Status?: number;
|
|
6098
6677
|
}
|
|
6678
|
+
/**
|
|
6679
|
+
* @public
|
|
6680
|
+
*/
|
|
6099
6681
|
export interface DescribeUserRequest {
|
|
6100
6682
|
/**
|
|
6101
6683
|
* <p>The name of the user that you want to describe.</p>
|
|
@@ -6111,10 +6693,16 @@ export interface DescribeUserRequest {
|
|
|
6111
6693
|
*/
|
|
6112
6694
|
Namespace: string | undefined;
|
|
6113
6695
|
}
|
|
6696
|
+
/**
|
|
6697
|
+
* @public
|
|
6698
|
+
*/
|
|
6114
6699
|
export declare enum IdentityType {
|
|
6115
6700
|
IAM = "IAM",
|
|
6116
6701
|
QUICKSIGHT = "QUICKSIGHT"
|
|
6117
6702
|
}
|
|
6703
|
+
/**
|
|
6704
|
+
* @public
|
|
6705
|
+
*/
|
|
6118
6706
|
export declare enum UserRole {
|
|
6119
6707
|
ADMIN = "ADMIN",
|
|
6120
6708
|
AUTHOR = "AUTHOR",
|
|
@@ -6123,6 +6711,7 @@ export declare enum UserRole {
|
|
|
6123
6711
|
RESTRICTED_READER = "RESTRICTED_READER"
|
|
6124
6712
|
}
|
|
6125
6713
|
/**
|
|
6714
|
+
* @public
|
|
6126
6715
|
* <p>A registered user of Amazon QuickSight. </p>
|
|
6127
6716
|
*/
|
|
6128
6717
|
export interface User {
|
|
@@ -6212,6 +6801,9 @@ export interface User {
|
|
|
6212
6801
|
*/
|
|
6213
6802
|
ExternalLoginId?: string;
|
|
6214
6803
|
}
|
|
6804
|
+
/**
|
|
6805
|
+
* @public
|
|
6806
|
+
*/
|
|
6215
6807
|
export interface DescribeUserResponse {
|
|
6216
6808
|
/**
|
|
6217
6809
|
* <p>The user name.</p>
|
|
@@ -6227,6 +6819,7 @@ export interface DescribeUserResponse {
|
|
|
6227
6819
|
Status?: number;
|
|
6228
6820
|
}
|
|
6229
6821
|
/**
|
|
6822
|
+
* @public
|
|
6230
6823
|
* <p>The domain specified isn't on the allow list. All domains for embedded dashboards must be
|
|
6231
6824
|
* added to the approved list by an Amazon QuickSight admin.</p>
|
|
6232
6825
|
*/
|
|
@@ -6243,11 +6836,17 @@ export declare class DomainNotWhitelistedException extends __BaseException {
|
|
|
6243
6836
|
*/
|
|
6244
6837
|
constructor(opts: __ExceptionOptionType<DomainNotWhitelistedException, __BaseException>);
|
|
6245
6838
|
}
|
|
6839
|
+
/**
|
|
6840
|
+
* @public
|
|
6841
|
+
*/
|
|
6246
6842
|
export declare enum EmbeddingIdentityType {
|
|
6247
6843
|
ANONYMOUS = "ANONYMOUS",
|
|
6248
6844
|
IAM = "IAM",
|
|
6249
6845
|
QUICKSIGHT = "QUICKSIGHT"
|
|
6250
6846
|
}
|
|
6847
|
+
/**
|
|
6848
|
+
* @public
|
|
6849
|
+
*/
|
|
6251
6850
|
export declare enum FolderFilterAttribute {
|
|
6252
6851
|
DIRECT_QUICKSIGHT_OWNER = "DIRECT_QUICKSIGHT_OWNER",
|
|
6253
6852
|
DIRECT_QUICKSIGHT_SOLE_OWNER = "DIRECT_QUICKSIGHT_SOLE_OWNER",
|
|
@@ -6258,6 +6857,7 @@ export declare enum FolderFilterAttribute {
|
|
|
6258
6857
|
QUICKSIGHT_VIEWER_OR_OWNER = "QUICKSIGHT_VIEWER_OR_OWNER"
|
|
6259
6858
|
}
|
|
6260
6859
|
/**
|
|
6860
|
+
* @public
|
|
6261
6861
|
* <p>An object that consists of a member Amazon Resource Name (ARN) and a member ID.</p>
|
|
6262
6862
|
*/
|
|
6263
6863
|
export interface MemberIdArnPair {
|
|
@@ -6271,6 +6871,7 @@ export interface MemberIdArnPair {
|
|
|
6271
6871
|
MemberArn?: string;
|
|
6272
6872
|
}
|
|
6273
6873
|
/**
|
|
6874
|
+
* @public
|
|
6274
6875
|
* <p>A filter to use to search an Amazon QuickSight folder.</p>
|
|
6275
6876
|
*/
|
|
6276
6877
|
export interface FolderSearchFilter {
|
|
@@ -6321,6 +6922,7 @@ export interface FolderSearchFilter {
|
|
|
6321
6922
|
Value?: string;
|
|
6322
6923
|
}
|
|
6323
6924
|
/**
|
|
6925
|
+
* @public
|
|
6324
6926
|
* <p>A summary of information about an existing Amazon QuickSight folder. </p>
|
|
6325
6927
|
*/
|
|
6326
6928
|
export interface FolderSummary {
|
|
@@ -6350,6 +6952,7 @@ export interface FolderSummary {
|
|
|
6350
6952
|
LastUpdatedTime?: Date;
|
|
6351
6953
|
}
|
|
6352
6954
|
/**
|
|
6955
|
+
* @public
|
|
6353
6956
|
* <p>The key-value pair used for the row-level security tags feature.</p>
|
|
6354
6957
|
*/
|
|
6355
6958
|
export interface SessionTag {
|
|
@@ -6362,6 +6965,9 @@ export interface SessionTag {
|
|
|
6362
6965
|
*/
|
|
6363
6966
|
Value: string | undefined;
|
|
6364
6967
|
}
|
|
6968
|
+
/**
|
|
6969
|
+
* @public
|
|
6970
|
+
*/
|
|
6365
6971
|
export interface GenerateEmbedUrlForAnonymousUserRequest {
|
|
6366
6972
|
/**
|
|
6367
6973
|
* <p>The ID for the Amazon Web Services account that contains the dashboard that you're embedding.</p>
|
|
@@ -6404,6 +7010,9 @@ export interface GenerateEmbedUrlForAnonymousUserRequest {
|
|
|
6404
7010
|
*/
|
|
6405
7011
|
AllowedDomains?: string[];
|
|
6406
7012
|
}
|
|
7013
|
+
/**
|
|
7014
|
+
* @public
|
|
7015
|
+
*/
|
|
6407
7016
|
export interface GenerateEmbedUrlForAnonymousUserResponse {
|
|
6408
7017
|
/**
|
|
6409
7018
|
* <p>The embed URL for the dashboard.</p>
|
|
@@ -6423,6 +7032,7 @@ export interface GenerateEmbedUrlForAnonymousUserResponse {
|
|
|
6423
7032
|
AnonymousUserArn: string | undefined;
|
|
6424
7033
|
}
|
|
6425
7034
|
/**
|
|
7035
|
+
* @public
|
|
6426
7036
|
* <p>The number of minutes specified for the lifetime of a session isn't valid. The session
|
|
6427
7037
|
* lifetime must be 15-600 minutes.</p>
|
|
6428
7038
|
*/
|
|
@@ -6440,6 +7050,7 @@ export declare class SessionLifetimeInMinutesInvalidException extends __BaseExce
|
|
|
6440
7050
|
constructor(opts: __ExceptionOptionType<SessionLifetimeInMinutesInvalidException, __BaseException>);
|
|
6441
7051
|
}
|
|
6442
7052
|
/**
|
|
7053
|
+
* @public
|
|
6443
7054
|
* <p>This error indicates that you are calling an embedding operation in Amazon QuickSight
|
|
6444
7055
|
* without the required pricing plan on your Amazon Web Services account. Before you can use embedding
|
|
6445
7056
|
* for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You
|
|
@@ -6464,6 +7075,7 @@ export declare class UnsupportedPricingPlanException extends __BaseException {
|
|
|
6464
7075
|
constructor(opts: __ExceptionOptionType<UnsupportedPricingPlanException, __BaseException>);
|
|
6465
7076
|
}
|
|
6466
7077
|
/**
|
|
7078
|
+
* @public
|
|
6467
7079
|
* <p>The state perssitence configuration of an embedded dashboard.</p>
|
|
6468
7080
|
*/
|
|
6469
7081
|
export interface StatePersistenceConfigurations {
|
|
@@ -6473,6 +7085,7 @@ export interface StatePersistenceConfigurations {
|
|
|
6473
7085
|
Enabled: boolean | undefined;
|
|
6474
7086
|
}
|
|
6475
7087
|
/**
|
|
7088
|
+
* @public
|
|
6476
7089
|
* <p>The feature configuration for an embedded dashboard.</p>
|
|
6477
7090
|
*/
|
|
6478
7091
|
export interface RegisteredUserDashboardFeatureConfigurations {
|
|
@@ -6482,6 +7095,7 @@ export interface RegisteredUserDashboardFeatureConfigurations {
|
|
|
6482
7095
|
StatePersistence?: StatePersistenceConfigurations;
|
|
6483
7096
|
}
|
|
6484
7097
|
/**
|
|
7098
|
+
* @public
|
|
6485
7099
|
* <p>Information about the dashboard you want to embed.</p>
|
|
6486
7100
|
*/
|
|
6487
7101
|
export interface RegisteredUserDashboardEmbeddingConfiguration {
|
|
@@ -6496,6 +7110,7 @@ export interface RegisteredUserDashboardEmbeddingConfiguration {
|
|
|
6496
7110
|
FeatureConfigurations?: RegisteredUserDashboardFeatureConfigurations;
|
|
6497
7111
|
}
|
|
6498
7112
|
/**
|
|
7113
|
+
* @public
|
|
6499
7114
|
* <p>The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.</p>
|
|
6500
7115
|
*/
|
|
6501
7116
|
export interface RegisteredUserDashboardVisualEmbeddingConfiguration {
|
|
@@ -6506,6 +7121,7 @@ export interface RegisteredUserDashboardVisualEmbeddingConfiguration {
|
|
|
6506
7121
|
InitialDashboardVisualId: DashboardVisualId | undefined;
|
|
6507
7122
|
}
|
|
6508
7123
|
/**
|
|
7124
|
+
* @public
|
|
6509
7125
|
* <p>Information about the Q search bar embedding experience.</p>
|
|
6510
7126
|
*/
|
|
6511
7127
|
export interface RegisteredUserQSearchBarEmbeddingConfiguration {
|
|
@@ -6520,6 +7136,7 @@ export interface RegisteredUserQSearchBarEmbeddingConfiguration {
|
|
|
6520
7136
|
InitialTopicId?: string;
|
|
6521
7137
|
}
|
|
6522
7138
|
/**
|
|
7139
|
+
* @public
|
|
6523
7140
|
* <p>The feature configurations of an embedded Amazon QuickSight console.</p>
|
|
6524
7141
|
*/
|
|
6525
7142
|
export interface RegisteredUserConsoleFeatureConfigurations {
|
|
@@ -6529,6 +7146,7 @@ export interface RegisteredUserConsoleFeatureConfigurations {
|
|
|
6529
7146
|
StatePersistence?: StatePersistenceConfigurations;
|
|
6530
7147
|
}
|
|
6531
7148
|
/**
|
|
7149
|
+
* @public
|
|
6532
7150
|
* <p>Information about the Amazon QuickSight console that you want to embed.</p>
|
|
6533
7151
|
*/
|
|
6534
7152
|
export interface RegisteredUserQuickSightConsoleEmbeddingConfiguration {
|
|
@@ -6573,6 +7191,7 @@ export interface RegisteredUserQuickSightConsoleEmbeddingConfiguration {
|
|
|
6573
7191
|
FeatureConfigurations?: RegisteredUserConsoleFeatureConfigurations;
|
|
6574
7192
|
}
|
|
6575
7193
|
/**
|
|
7194
|
+
* @public
|
|
6576
7195
|
* <p>The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console.</p>
|
|
6577
7196
|
* <note>
|
|
6578
7197
|
* <p>Exactly one of the experience configurations is required. You can choose
|
|
@@ -6629,6 +7248,9 @@ export interface RegisteredUserEmbeddingExperienceConfiguration {
|
|
|
6629
7248
|
*/
|
|
6630
7249
|
DashboardVisual?: RegisteredUserDashboardVisualEmbeddingConfiguration;
|
|
6631
7250
|
}
|
|
7251
|
+
/**
|
|
7252
|
+
* @public
|
|
7253
|
+
*/
|
|
6632
7254
|
export interface GenerateEmbedUrlForRegisteredUserRequest {
|
|
6633
7255
|
/**
|
|
6634
7256
|
* <p>The ID for the Amazon Web Services account that contains the dashboard that you're embedding.</p>
|
|
@@ -6658,6 +7280,9 @@ export interface GenerateEmbedUrlForRegisteredUserRequest {
|
|
|
6658
7280
|
*/
|
|
6659
7281
|
AllowedDomains?: string[];
|
|
6660
7282
|
}
|
|
7283
|
+
/**
|
|
7284
|
+
* @public
|
|
7285
|
+
*/
|
|
6661
7286
|
export interface GenerateEmbedUrlForRegisteredUserResponse {
|
|
6662
7287
|
/**
|
|
6663
7288
|
* <p>The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, or console.</p>
|
|
@@ -6673,6 +7298,7 @@ export interface GenerateEmbedUrlForRegisteredUserResponse {
|
|
|
6673
7298
|
RequestId: string | undefined;
|
|
6674
7299
|
}
|
|
6675
7300
|
/**
|
|
7301
|
+
* @public
|
|
6676
7302
|
* <p>The user with the provided name isn't found. This error can happen in any operation
|
|
6677
7303
|
* that requires finding a user based on a provided user name, such as
|
|
6678
7304
|
* <code>DeleteUser</code>, <code>DescribeUser</code>, and so on.</p>
|
|
@@ -6690,6 +7316,9 @@ export declare class QuickSightUserNotFoundException extends __BaseException {
|
|
|
6690
7316
|
*/
|
|
6691
7317
|
constructor(opts: __ExceptionOptionType<QuickSightUserNotFoundException, __BaseException>);
|
|
6692
7318
|
}
|
|
7319
|
+
/**
|
|
7320
|
+
* @public
|
|
7321
|
+
*/
|
|
6693
7322
|
export interface GetDashboardEmbedUrlRequest {
|
|
6694
7323
|
/**
|
|
6695
7324
|
* <p>The ID for the Amazon Web Services account that contains the dashboard that you're embedding.</p>
|